Foundation
This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v5.0.0:
R5
-
STU
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
| Responsible Owner: Patient Administration Work Group | Standards Status : Informative | Compartments : No defined compartments |
ShEx statement for healthcareservice
PREFIX fhir: <http://hl7.org/fhir/> PREFIX fhirvs: <http://hl7.org/fhir/ValueSet/> PREFIX xsd: <http://www.w3.org/2001/XMLSchema#> PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>IMPORT <string.shex> IMPORT <boolean.shex> IMPORT <markdown.shex># ShEx Version 2.2 IMPORT <Range.shex> IMPORT <String.shex> IMPORT <Boolean.shex> IMPORT <Markdown.shex> IMPORT <Quantity.shex> IMPORT <Location.shex> IMPORT <Endpoint.shex> IMPORT <Reference.shex> IMPORT <Identifier.shex> IMPORT <Attachment.shex> IMPORT <Organization.shex> IMPORT <Availability.shex> IMPORT <DomainResource.shex> IMPORT <CodeableConcept.shex> IMPORT <BackboneElement.shex> IMPORT <ExtendedContactDetail.shex> start=@<HealthcareService> AND {fhir:nodeRole [fhir:treeRoot]} # The details of a healthcare service available at a location <HealthcareService> EXTENDS @<DomainResource> CLOSED {a [fhir:HealthcareService]?; fhir:nodeRole [fhir:treeRoot]?;a [fhir:HealthcareService]?;fhir:nodeRole [fhir:treeRoot]?; fhir:identifier @<OneOrMore_Identifier>?; # External identifiers for this itemfhir:active @<boolean>?; # Whether this HealthcareServicefhir:active @<Boolean>?; # Whether this HealthcareService # record is in active usefhir:providedBy @<Reference> AND {fhir:linkfhir:providedBy @<Reference> AND {fhir:l @<Organization> ? }?; # Organization that provides this # service fhir:offeredIn @<OneOrMore_Reference_HealthcareService>?; # The service within which this # service is offered fhir:category @<OneOrMore_CodeableConcept>?; # Broad category of service being # performed or delivered fhir:type @<OneOrMore_CodeableConcept>?; # Type of service that may be # delivered or performed fhir:specialty @<OneOrMore_CodeableConcept>?; # Specialties handled by the # HealthcareService fhir:location @<OneOrMore_Reference_Location>?; # Location(s) where service may be # providedfhir:name @<string>?; # Description of service asfhir:name @<String>?; # Description of service as # presented to a consumer while # searchingfhir:comment @<markdown>?; # Additional description and/or anyfhir:comment @<Markdown>?; # Additional description and/or any # specific issues not covered # elsewherefhir:extraDetails @<markdown>?; # Extra details about the servicefhir:extraDetails @<Markdown>?; # Extra details about the service # that can't be placed in the other # fields fhir:photo @<Attachment>?; # Facilitates quick identification # of the service fhir:contact @<OneOrMore_ExtendedContactDetail>?; # Official contact details for the # HealthcareService fhir:coverageArea @<OneOrMore_Reference_Location>?; # Location(s) service is intended # for/available to fhir:serviceProvisionCode @<OneOrMore_CodeableConcept>?; # Conditions under which service is # available/offered fhir:eligibility @<OneOrMore_HealthcareService.eligibility>?; # Specific eligibility requirements # required to use the service fhir:program @<OneOrMore_CodeableConcept>?; # Programs that this service is # applicable to fhir:characteristic @<OneOrMore_CodeableConcept>?; # Collection of characteristics # (attributes) fhir:communication @<OneOrMore_CodeableConcept>?; # The language that this service is # offered in fhir:referralMethod @<OneOrMore_CodeableConcept>?; # Ways that the service accepts # referralsfhir:appointmentRequired @<boolean>?; # If an appointment is required forfhir:referralRequired @<Boolean>?; # A referral is required for access # to this service fhir:appointmentRequired @<Boolean>?; # An appointment is required for # access to this servicefhir:availability @<OneOrMore_Availability>?; # Times the healthcare service isfhir:availability @<Availability>?; # Times the healthcare service is # available (including exceptions) fhir:endpoint @<OneOrMore_Reference_Endpoint>?; # Technical endpoints providing # access to electronic services # operated for the healthcare # service } # Specific eligibility requirements required to use the service <HealthcareService.eligibility> EXTENDS @<BackboneElement> CLOSED { fhir:code @<CodeableConcept>?; # Coded value for the eligibilityfhir:comment @<markdown>?; # Describes the eligibilityfhir:value @<CodeableConcept> OR @<Boolean> OR @<Quantity> OR @<Range> OR @<Reference> ?; # Value associated with the # eligibility code fhir:comment @<Markdown>?; # Describes the eligibility # conditions for the service fhir:period @<Markdown>?; # The period this eligibility rule # applies } #---------------------- Cardinality Types (OneOrMore) ------------------- <OneOrMore_Identifier> CLOSED { rdf:first @<Identifier> ; rdf:rest [rdf:nil] OR @<OneOrMore_Identifier> } <OneOrMore_Reference_HealthcareService> CLOSED {rdf:first @<Reference> AND {fhir:linkrdf:first @<Reference> AND {fhir:l @<HealthcareService> } ; rdf:rest [rdf:nil] OR @<OneOrMore_Reference_HealthcareService> } <OneOrMore_CodeableConcept> CLOSED { rdf:first @<CodeableConcept> ; rdf:rest [rdf:nil] OR @<OneOrMore_CodeableConcept> } <OneOrMore_Reference_Location> CLOSED {rdf:first @<Reference> AND {fhir:linkrdf:first @<Reference> AND {fhir:l @<Location> } ; rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Location> } <OneOrMore_ExtendedContactDetail> CLOSED { rdf:first @<ExtendedContactDetail> ; rdf:rest [rdf:nil] OR @<OneOrMore_ExtendedContactDetail> } <OneOrMore_HealthcareService.eligibility> CLOSED { rdf:first @<HealthcareService.eligibility> ; rdf:rest [rdf:nil] OR @<OneOrMore_HealthcareService.eligibility> }<OneOrMore_Availability> CLOSED { rdf:first @<Availability> ; rdf:rest [rdf:nil] OR @<OneOrMore_Availability> }<OneOrMore_Reference_Endpoint> CLOSED {rdf:first @<Reference> AND {fhir:linkrdf:first @<Reference> AND {fhir:l @<Endpoint> } ; rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Endpoint> }
Usage note: every effort has been made to ensure that the ShEx files are correct and useful, but they are not a normative part of the specification.
FHIR
®©
HL7.org
2011+.
FHIR
R5
hl7.fhir.core#5.0.0
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Sun,
Mar
26,
2023
15:24+1100.
Thu,
Nov
13,
2025
03:07+0000.
Links:
Search
|
Version
History
|
Contents
|
Glossary
|
QA
|
Compare
to
R4
|
Compare
to
R4B
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change