This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
ShEx statement for practitioner
PREFIX fhir: <http://hl7.org/fhir/> PREFIX fhirvs: <http://hl7.org/fhir/ValueSet/> PREFIX xsd: <http://www.w3.org/2001/XMLSchema#> BASE <http://hl7.org/fhir/shape/> start=<Practitioner> AND {fhir:nodeRole [fhir:treeRoot]} # A person with a formal responsibility in the provisioning of healthcare or related services <Practitioner> CLOSED { a [fhir:Practitioner]; fhir:nodeRole [fhir:treeRoot]?; fhir:Resource.id @<id>?; # Logical id of this artifact fhir:Resource.meta @<Meta>?; # Metadata about the resource fhir:Resource.implicitRules @<uri>?; # A set of rules under which this # content was created fhir:Resource.language @<code>?; # Language of the resource content fhir:DomainResource.text @<Narrative>?; # Text summary of the resource, for # human interpretation fhir:DomainResource.contained @<Resource>*; # Contained, inline Resources fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:modifierExtension @<Extension>*; # Extensions that cannot be ignored fhir:Practitioner.identifier @<Identifier>*; # A identifier for the person as # this agent fhir:Practitioner.active @<boolean>?; # Whether this practitioner's record # is in active use fhir:Practitioner.name @<HumanName>*; # The name(s) associated with the # practitioner fhir:Practitioner.telecom @<ContactPoint>*; # A contact detail for the # practitioner (that apply to all # roles) fhir:Practitioner.address @<Address>*; # Address(es) of the practitioner # that are not role specific # (typically home address) fhir:Practitioner.gender @<code> AND {fhir:value @fhirvs:administrative-gender}?; # male | female | other | unknown fhir:Practitioner.birthDate @<date>?; # The date on which the # practitioner was born fhir:Practitioner.photo @<Attachment>*; # Image of the person fhir:Practitioner.role @<Practitioner.role>*; # Roles/organizations the # practitioner is associated with fhir:Practitioner.qualification @<Practitioner.qualification>*; # Qualifications obtained by # training and certification fhir:Practitioner.communication @<CodeableConcept>*; # A language the practitioner is # able to use in patient # communication fhir:index xsd:integer? # Relative position in a list } # Qualifications obtained by training and certification <Practitioner.qualification> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:modifierExtension @<Extension>*; # Extensions that cannot be ignored fhir:Practitioner.qualification.identifier @<Identifier>*; # An identifier for this # qualification for the practitioner fhir:Practitioner.qualification.code @<CodeableConcept>; # Coded representation of the # qualification fhir:Practitioner.qualification.period @<Period>?; # Period during which the # qualification is valid fhir:Practitioner.qualification.issuer @<OrganizationReference>?; # Organization that regulates and # issues the qualification fhir:index xsd:integer? # Relative position in a list } # Roles/organizations the practitioner is associated with <Practitioner.role> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:modifierExtension @<Extension>*; # Extensions that cannot be ignored fhir:Practitioner.role.organization @<OrganizationReference>?; # Organization where the roles are # performed fhir:Practitioner.role.code @<CodeableConcept>?; # Roles which this practitioner may # perform fhir:Practitioner.role.specialty @<CodeableConcept>*; # Specific specialty of the # practitioner fhir:Practitioner.role.identifier @<Identifier>*; # Business Identifiers that are # specific to a role/location fhir:Practitioner.role.telecom @<ContactPoint>*; # Contact details that are specific # to the role/location/service fhir:Practitioner.role.period @<Period>?; # The period during which the # practitioner is authorized to # perform in these role(s) fhir:Practitioner.role.location @<LocationReference>*; # The location(s) at which this # practitioner provides care fhir:Practitioner.role.healthcareService @<HealthcareServiceReference>*; # The list of healthcare services # that this worker provides for this # role's Organization/Location(s) fhir:Practitioner.role.endpoint @<EndpointReference>*; # Technical endpoints providing # access to services operated for # the PractitonerRole fhir:index xsd:integer? # Relative position in a list } #---------------------- Data Types ------------------- # Primitive Type date <date> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:gYear OR xsd:gYearMonth OR xsd:date?; # Primitive value for date fhir:index xsd:integer? # Relative position in a list } # Metadata about a resource <Meta> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Meta.versionId @<id>?; # Version specific identifier fhir:Meta.lastUpdated @<instant>?; # When the resource version last # changed fhir:Meta.profile @<uri>*; # Profiles this resource claims to # conform to fhir:Meta.security @<Coding>*; # Security Labels applied to this # resource fhir:Meta.tag @<Coding>*; # Tags applied to this resource fhir:index xsd:integer? # Relative position in a list } # Primitive Type code <code> CLOSED { fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:string?; # Primitive value for code fhir:index xsd:integer? # Relative position in a list } # An address expressed using postal conventions (as opposed to GPS or other location definition formats) <Address> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Address.use @<code> AND {fhir:value @fhirvs:address-use}?; # home | work | temp | old - purpose # of this address fhir:Address.type @<code> AND {fhir:value @fhirvs:address-type}?; # postal | physical | both fhir:Address.text @<string>?; # Text representation of the address fhir:Address.line @<string>*; # Street name, number, direction & # P.O. Box etc. fhir:Address.city @<string>?; # Name of city, town etc. fhir:Address.district @<string>?; # District name (aka county) fhir:Address.state @<string>?; # Sub-unit of country (abbreviations # ok) fhir:Address.postalCode @<string>?; # Postal code for area fhir:Address.country @<string>?; # Country (can be ISO 3166 3 letter # code) fhir:Address.period @<Period>?; # Time period when address was/is in # use fhir:index xsd:integer? # Relative position in a list } # Primitive Type string <string> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:string MAXLENGTH 1048576?; # Primitive value for string fhir:index xsd:integer? # Relative position in a list } # Base Resource <Resource> {a .+; fhir:Resource.id @<id>?; # Logical id of this artifact fhir:Resource.meta @<Meta>?; # Metadata about the resource fhir:Resource.implicitRules @<uri>?; # A set of rules under which this # content was created fhir:Resource.language @<code>?; # Language of the resource content fhir:index xsd:integer? } # Time range defined by start and end date/time <Period> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Period.start @<dateTime>?; # Starting time with inclusive # boundary fhir:Period.end @<dateTime>?; # End time with inclusive boundary, # if not ongoing fhir:index xsd:integer? # Relative position in a list } # Content in a format defined elsewhere <Attachment> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Attachment.contentType @<code>?; # Mime type of the content, with # charset etc. fhir:Attachment.language @<code>?; # Human language of the content # (BCP-47) fhir:Attachment.data @<base64Binary>?; # Data inline, base64ed fhir:Attachment.url @<uri>?; # Uri where the data can be found fhir:Attachment.size @<unsignedInt>?; # Number of bytes of content (if url # provided) fhir:Attachment.hash @<base64Binary>?; # Hash of the data (sha-1, base64ed) fhir:Attachment.title @<string>?; # Label to display in place of the # data fhir:Attachment.creation @<dateTime>?; # Date attachment was first created fhir:index xsd:integer? # Relative position in a list } # Primitive Type uri <uri> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:string?; # Primitive value for uri fhir:index xsd:integer? # Relative position in a list } <Extension> {fhir:extension @<Extension>*; fhir:index xsd:integer? } # Name of a human - parts and usage <HumanName> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:HumanName.use @<code> AND {fhir:value @fhirvs:name-use}?; # usual | official | temp | nickname # | anonymous | old | maiden fhir:HumanName.text @<string>?; # Text representation of the full # name fhir:HumanName.family @<string>*; # Family name (often called # 'Surname') fhir:HumanName.given @<string>*; # Given names (not always 'first'). # Includes middle names fhir:HumanName.prefix @<string>*; # Parts that come before the name fhir:HumanName.suffix @<string>*; # Parts that come after the name fhir:HumanName.period @<Period>?; # Time period when name was/is in use fhir:index xsd:integer? # Relative position in a list } # Details of a Technology mediated contact point (phone, fax, email, etc.) <ContactPoint> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:ContactPoint.system @<code> AND {fhir:value @fhirvs:contact-point-system}?; # phone | fax | email | pager | other fhir:ContactPoint.value @<string>?; # The actual contact point details fhir:ContactPoint.use @<code> AND {fhir:value @fhirvs:contact-point-use}?; # home | work | temp | old | mobile # - purpose of this contact point fhir:ContactPoint.rank @<positiveInt>?; # Specify preferred order of use (1 # = highest) fhir:ContactPoint.period @<Period>?; # Time period when the contact point # was/is in use fhir:index xsd:integer? # Relative position in a list } # An identifier intended for computation <Identifier> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Identifier.use @<code> AND {fhir:value @fhirvs:identifier-use}?; # usual | official | temp | # secondary (If known) fhir:Identifier.type @<CodeableConcept>?; # Description of identifier fhir:Identifier.system @<uri>?; # The namespace for the identifier fhir:Identifier.value @<string>?; # The value that is unique fhir:Identifier.period @<Period>?; # Time period when id is/was valid # for use fhir:Identifier.assigner @<OrganizationReference>?; # Organization that issued id (may # be just text) fhir:index xsd:integer? # Relative position in a list } # Primitive Type boolean <boolean> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:boolean?; # Primitive value for boolean fhir:index xsd:integer? # Relative position in a list } # A human-readable formatted text, including images <Narrative> CLOSED { fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Narrative.status @<code> AND {fhir:value @fhirvs:narrative-status}; # generated | extensions | # additional | empty fhir:Narrative.div xsd:string; # Limited xhtml content fhir:index xsd:integer? # Relative position in a list } # Primitive Type id <id> CLOSED { fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:string?; # Primitive value for id fhir:index xsd:integer? # Relative position in a list } # Concept - reference to a terminology or just text <CodeableConcept> CLOSED { fhir:concept IRI*; fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:CodeableConcept.coding @<Coding>*; # Code defined by a terminology # system fhir:CodeableConcept.text @<string>?; # Plain text representation of the # concept fhir:index xsd:integer? # Relative position in a list } # Primitive Type dateTime <dateTime> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:gYear OR xsd:gYearMonth OR xsd:date OR xsd:dateTime?; # Primitive value for dateTime fhir:index xsd:integer? # Relative position in a list } # Primitive Type instant <instant> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:dateTime?; # Primitive value for instant fhir:index xsd:integer? # Relative position in a list } # A reference to a code defined by a terminology system <Coding> CLOSED { fhir:concept IRI?; fhir:Element.id @<string>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:Coding.system @<uri>?; # Identity of the terminology system fhir:Coding.version @<string>?; # Version of the system - if relevant fhir:Coding.code @<code>?; # Symbol in syntax defined by the # system fhir:Coding.display @<string>?; # Representation defined by the # system fhir:Coding.userSelected @<boolean>?; # If this coding was chosen directly # by the user fhir:index xsd:integer? # Relative position in a list } # Primitive Type base64Binary <base64Binary> CLOSED { fhir:id @<id>?; # xml:id (or equivalent in JSON) fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:base64Binary?; # Primitive value for base64Binary fhir:index xsd:integer? # Relative position in a list } # Primitive Type unsignedInt <unsignedInt> CLOSED { fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:nonNegativeInteger?; # Primitive value for unsignedInt fhir:index xsd:integer? # Relative position in a list } # Primitive Type positiveInt <positiveInt> CLOSED { fhir:extension @<Extension>*; # Additional Content defined by # implementations fhir:value xsd:positiveInteger?; # Primitive value for positiveInt fhir:index xsd:integer? # Relative position in a list } #---------------------- Reference Types ------------------- <OrganizationReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Organization> OR CLOSED {a fhir:Organization}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <EndpointReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Endpoint> OR CLOSED {a fhir:Endpoint}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <HealthcareServiceReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<HealthcareService> OR CLOSED {a fhir:HealthcareService}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } <LocationReference> CLOSED { fhir:Element.id @<id>?; fhir:extension @<Extension>*; fhir:link @<Location> OR CLOSED {a fhir:Location}?; fhir:Reference.reference @<string>?; fhir:Reference.display @<string>?; fhir:index xsd:integer? } #---------------------- Value Sets ------------------------ # Use of contact point @fhirvs:contact-point-use = ["home" "work" "temp" "old" "mobile"] # The gender of a person used for administrative purposes. @fhirvs:administrative-gender = ["male" "female" "other" "unknown"] # The use of a human name @fhirvs:name-use = ["usual" "official" "temp" "nickname" "anonymous" "old" "maiden"] # Telecommunications form for contact point @fhirvs:contact-point-system = ["phone" "fax" "email" "pager" "other"] # The status of a resource narrative @fhirvs:narrative-status = ["generated" "extensions" "additional" "empty"] # The type of an address (physical / postal) @fhirvs:address-type = ["postal" "physical" "both"] # The use of an address @fhirvs:address-use = ["home" "work" "temp" "old"] # Identifies the purpose for this identifier, if known . @fhirvs:identifier-use = ["usual" "official" "temp" "secondary"]
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.