3.55 StructureDefinition: Shared Health Practitioner - Provider Registry
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner-tpr
3.55.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Practitioner
Name | Card. | Type | Constraints and Usage |
---|---|---|---|
Practitioner | 0..* | Practitioner | Definition: A person who is directly or indirectly involved in the provisioning of healthcare. Comments: |
id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: This value should be populated with the CPRID of the practitioner this resource describes. The CPRID of the practitioner is the business identifier used within the Provider Registry to uniquely identify a practitioner. |
meta | 1..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
tag | 1..* | Coding | Slice: Unordered, Open by value:system Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
tag (version) | 1..1 | Coding | Binding: SharedSpecificationVersion (20210501) (required) Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (service) | 0..* | Entity Service | Definition: Identifies a electronic communication service offered by a service location or practitioner Comments: Entity Service is used at this level, when the service registration process requires participation at both the Organization level and the Practitioner level. Both levels must be validated to confirm the outcome. This is returned in the response when the service is determined to be active. It will be absent from the response when the service is no longer active. |
identifier | 0..* | Shared Health Person Identifier | Slice: Unordered, Open by pattern:type Definition: A technical identifier - identifies some entity uniquely and unambiguously. Comments: Two identifiers will be provided - the Provider Registry identifier, denoted by an Identifier.type code of 'PRN' and the provider license number, denoted by an Identifier.type.coding.code of 'LN'. Conformance Rule: The Provider Registry identifier SHALL be sent if the practioner is the initiating practitioner for the tasks in a message. The Provider Registry identifier SHOULD be sent if known if the practitioner is being sent for other purposes (e.g. the prescriber of a prescription for which a renewal is being sought). When transmitting the provider license number (always mandatory), the Identifier.type shall have a coding from the 'http://hl7.org/fhir/v2/0203' system of 'LN'. For the specific license type expressed as a urn (e.g. urn:oid:1.2.3.4). In a future version of this specification, we may be migrating from OIDs to more readable URL’s. You can plan for this in your design. Conformance Rule: The second identifier provided will be the licence ID of the Prescriber. The assigning authority OID will be determined based on the licencing body; a list of which is found within the Vendor Implementation guide. |
identifier (registry) | 1..1 | Identifier | Definition: An identifier that applies to this person in this role. Comments: This is the same id as found on Practitioner.id, but expressed as a business identifier - it will remain the same as the Practitioner resource is stored on different systems. In the context of Pharmacist Adapt (p170) and Pharmacist Prescribe (p190), no value will exist as pharmacists are not registered. |
type | 1..1 | Shared Health CodeableConcept Code | Binding: IdentifierType (20210501) (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PRN"}]} Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: |
system | 1..1 | uri | Fixed Value: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner Definition: Establishes the namespace in which set of possible id values is unique. Comments: Fixed value: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner |
value | 1..1 | string | Example' General': 123456 Definition: The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments: Conformance Rule: This SHALL match the practitioner.id value. |
identifier (license) | 0..10 | Identifier | Definition: An identifier that applies to this person in this role. Comments: Conformance Rule: Only a single licence number can be submitted. For Prescriber's with multiple licence numbers, the licence number must be the one that the Prescriber is acting under the authority of when Prescribing. In the context of Pharmacist Adapt (p170) and Pharmacist Prescribe (p190), populate with Pharmacist licensing body and license number |
type | 1..1 | Shared Health CodeableConcept Code Required and Text Required | Binding: IdentifierType (20210501) (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"LN"}]} Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: |
system | 1..1 | uri | Binding: SharedPractitionerIdentifierType (required) Example' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri Definition: Establishes the namespace in which set of possible id values is unique. Comments: The jurisdictional licensing body (e.g. College of Physicians and Surgeons) that issued the practitioner’s license, chosen from terminology binding (this will be an OID expressed as a URI). |
value | 1..1 | string | Example' General': 123456 Definition: The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments: This is the Practitioner license number |
name | 1..1 | Shared Health HumanName | Definition: A human's name with the ability to identify parts and usage. Comments: Usage Note: The last name provided within this segment is validated against the name in the SAML token. It is also used to populate faxes during the “fail to fax” scenario. |
telecom | 0..* | Shared Health ContactPoint | cpt-2: A system is required if a value is provided. Definition: This segment provide methods of contacting the practitioner. Only numbers that have authorized to be disclosed by the practitioner should be included. For example, most practitioners do not authorize the disclosure of their cell phone number to pharmacies. Comments: |
practitionerRole | 0..* | BackboneElement | practitionerRole-1: Must have at least one of organization and role Definition: The list of roles/organizations that the practitioner is associated with. Comments: The address to be used for this PractitionerRole is in the referenced location (removing duplication across all the services provided at the location). |
organization | 0..1 | Reference(Shared Health Organization - Provider Registry) {r} | Definition: A reference from one resource to another. |
reference | 1..1 | string | Definition: This is a reference to the resource within the current bundle that represents the organization the practitioner is working for. Comments: |
role | 0..1 | Shared Health CodeableConcept Code | Binding: SharedPractitionerRole (20190415) (required) Definition: In the context of EMR messages: The prescribers role that is associated to the prescribers license number in the context the clinical event this message is related to. In the context of PMS messages: The prescribers role that is associated to the prescribers license number in the context the event this message is related to. In the context of PR Query Responses: The prescribers role that is associated to the prescribers license number. The prescriber can only have 1 role per license number. Comments: In the context of EMR messages: Conformance Rule: EMR vendors must populate this segment with the associated prescribers role that is related to the license number that is being submitted in the message. The role that is stored and submitted must match the prescribers registered role within the PrescribeIT Provider Registry. In the context of PMS messages: Conformance Rule: PMS vendors should populate this segment with the associated prescribers role that is related to the license number that is being submitted in the message. In the context of Query Response, the prescriber role as associated to the license number will be returned. |
coding | 1..* | Coding | Definition: A reference to a code defined by a terminology system. Comments: |
system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: This is the code as defined within the binding. |
display | 1..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
extension (roleTranslation) | 0..1 | translation | Definition: An expression of the original string in an alternate language. Comments: string-translation elements should not have string-translation extensions (i.e. all translations should be expressed as siblings, not as a translation hierarchy) to simplify processing. |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" |
value[x] | 1..1 | string | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
extension (roleTranslationLanguage) | 1..1 | language | Definition: The language in which the string is expressed. |
specialty | 0..* | Shared Health CodeableConcept Required Text with optional code | Binding: PractitionerSpecialty (example): Specific specialty associated with the agency Definition: The area(s) of medicine that a prescriber specializes in (i.e. Cardiology, Pediatrics, Oncology etc.) Comments: In the context of PR Query Response, at the present time, the prescriber specialty as recorded will be returned as text only in both English and French. Coding will not be returned. Conformance Rule: Vendors must populate this segment with the associated prescribers specialties. If a prescriber does not have a specialty the same value that is sent as the role can be sent as the specialty value. |
coding | 0..1 | Coding | Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: This is the code as defined within the binding. |
text | 1..1 | string | Max Length: 2500 Definition: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Comments: If a free text description of the practitioner’s specialty is available, it must be provided here. If no free text description is available, the value from practitionerRole(practitionerSpecialty).role.coding.display must be provided here. In the context of Pharmacist Adapt (p170) and Pharmacist Prescribe (p190), populate with 'Pharmacist' |
extension (specialtyTranslation) | 0..1 | translation | Definition: An expression of the original string in an alternate language. Comments: string-translation elements should not have string-translation extensions (i.e. all translations should be expressed as siblings, not as a translation hierarchy) to simplify processing. |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" |
value[x] | 1..1 | string | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
extension (specialtyTranslationLanguage) | 1..1 | language | Definition: The language in which the string is expressed. |
communication | 1..* | Shared Health CodeableConcept Code Required with Text Optional | Binding: SharedCommunicationLanguage (20170626) (required) Definition: This will convey the language of the User who is sending the request. Comments: Conformance Rule: Text is optionally supported and if communication is French, can be set to French. In the context of PR Practitioner or Organization Search, this represents the Practitioner's spoken languages (e.g. en-CA for English and fr-CA for French. If both languages are present it means that Practitioner is bilingual. |
This structure is derived from Practitioner
Summary
Mandatory: 12 elements (12 nested mandatory elements)
Must-Support: 36 elements
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-identifier-person
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code-required-text-required
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-humanname
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-contactpoint
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-reference
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-organization-tpr
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-text-required-with-code
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code-required-with-text
Extensions
This structure refers to these extensions:
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service
- http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
- http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Slices
This structure defines the following Slices:
- The element Practitioner.meta.tag is sliced based on the value of value:system
- The element Practitioner.identifier is sliced based on the value of pattern:type
This structure is derived from Practitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | S | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services |
id | S | 1..1 | id | Logical id of this artifact |
meta | S | 1..1 | Meta | Metadata about the resource |
tag | S | 1..* | (Slice Definition) | Tags applied to this resource Slice: Unordered, Open by value:system |
tag:version | S | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (20210501) (required) |
system | S | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
code | S | 1..1 | code | Symbol in syntax defined by the system |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-entity-service | S | 0..* | (Complex) | Entity Service URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service |
identifier | S | 0..* | (Slice Definition) | An identifier intended for computation Slice: Unordered, Open by pattern:type |
identifier:registry | S | 1..1 | Identifier | A identifier for the person as this agent |
type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: IdentifierType (20210501) (extensible) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
system | S | 1..1 | uri | The namespace for the identifier Fixed Value: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner |
value | S | 1..1 | string | The value that is unique |
identifier:license | S | 0..10 | Identifier | A identifier for the person as this agent |
type | S | 1..1 | Shared Health CodeableConcept Code Required and Text Required | Concept - reference to a terminology or just text Binding: IdentifierType (20210501) (extensible) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LN | |
system | S | 1..1 | uri | The namespace for the identifier Binding: SharedPractitionerIdentifierType (required) |
value | S | 1..1 | string | The value that is unique |
name | S | 1..1 | Shared Health HumanName | Name of a human - parts and usage |
telecom | S | 0..* | Shared Health ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
practitionerRole | SI | 0..* | BackboneElement | Roles/organizations the practitioner is associated with practitionerRole-1: Must have at least one of organization and role |
organization | SI | 0..1 | Reference(Shared Health Organization - Provider Registry) {r} | A reference from one resource to another |
reference | S | 1..1 | string | Relative, internal or absolute URL reference |
role | SI | 0..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: SharedPractitionerRole (20190415) (required) |
coding | S | 1..* | Coding | Code defined by a terminology system |
display | S | 1..1 | string | Representation defined by the system |
iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
url | S | 1..1 | uri | identifies the meaning of the extension |
value[x] | S | 1..1 | string | Value of extension |
iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
specialty | S | 0..* | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text |
text | S | 1..1 | string | Plain text representation of the concept |
iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
url | S | 1..1 | uri | identifies the meaning of the extension |
value[x] | S | 1..1 | string | Value of extension |
iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
communication | S | 1..* | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text Binding: SharedCommunicationLanguage (20170626) (required) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | S | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services |
id | SΣ | 1..1 | id | Logical id of this artifact |
meta | SΣ | 1..1 | Meta | Metadata about the resource |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
profile | Σ | 0..* | uri | Profiles this resource claims to conform to |
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
tag | SΣ | 1..* | (Slice Definition) | Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
tag:version | SΣ | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (20210501) (required) |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-entity-service | S | 0..* | (Complex) | Entity Service URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | (Slice Definition) | An identifier intended for computation Slice: Unordered, Open by pattern:type |
identifier:registry | SΣ | 1..1 | Identifier | A identifier for the person as this agent |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: IdentifierType (20210501) (extensible) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
system | SΣ | 1..1 | uri | The namespace for the identifier Fixed Value: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
identifier:license | SΣ | 0..10 | Identifier | A identifier for the person as this agent |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | S | 1..1 | Shared Health CodeableConcept Code Required and Text Required | Concept - reference to a terminology or just text Binding: IdentifierType (20210501) (extensible) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LN | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
system | SΣ | 1..1 | uri | The namespace for the identifier Binding: SharedPractitionerIdentifierType (required) Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use |
name | S | 1..1 | Shared Health HumanName | Name of a human - parts and usage |
telecom | SI | 0..* | Shared Health ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
address | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
birthDate | Σ | 0..1 | date | The date on which the practitioner was born |
photo | 0..* | Attachment | Image of the person | |
practitionerRole | SI | 0..* | BackboneElement | Roles/organizations the practitioner is associated with practitionerRole-1: Must have at least one of organization and role |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
organization | SI | 0..1 | Reference(Shared Health Organization - Provider Registry) {r} | A reference from one resource to another |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
role | SI | 0..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: SharedPractitionerRole (20190415) (required) |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | SΣ | 1..1 | string | Representation defined by the system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" |
value[x] | S | 1..1 | string | Value of extension |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
specialty | S | 0..* | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text Binding: PractitionerSpecialty (example): Specific specialty associated with the agency |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | SΣ | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | SΣ | 1..1 | string | Plain text representation of the concept Max Length: 2500 |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" |
value[x] | S | 1..1 | string | Value of extension |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location |
telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
location | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | |
healthcareService | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
qualification | 0..* | BackboneElement | Qualifications obtained by training and certification | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | An identifier for this qualification for the practitioner | |
code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 (example): Specific qualification the practitioner has to provide a service | |
period | 0..1 | Period | Period during which the qualification is valid | |
issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |
communication | S | 1..* | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text Binding: SharedCommunicationLanguage (20170626) (required) |
Documentation for this format |
Grid View
This structure is derived from Practitioner
Name | Card. | Type | Constraints and Usage |
---|---|---|---|
Practitioner | 0..* | Practitioner | Definition: A person who is directly or indirectly involved in the provisioning of healthcare. Comments: |
id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: This value should be populated with the CPRID of the practitioner this resource describes. The CPRID of the practitioner is the business identifier used within the Provider Registry to uniquely identify a practitioner. |
meta | 1..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
tag | 1..* | Coding | Slice: Unordered, Open by value:system Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
tag (version) | 1..1 | Coding | Binding: SharedSpecificationVersion (20210501) (required) Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (service) | 0..* | Entity Service | Definition: Identifies a electronic communication service offered by a service location or practitioner Comments: Entity Service is used at this level, when the service registration process requires participation at both the Organization level and the Practitioner level. Both levels must be validated to confirm the outcome. This is returned in the response when the service is determined to be active. It will be absent from the response when the service is no longer active. |
identifier | 0..* | Shared Health Person Identifier | Slice: Unordered, Open by pattern:type Definition: A technical identifier - identifies some entity uniquely and unambiguously. Comments: Two identifiers will be provided - the Provider Registry identifier, denoted by an Identifier.type code of 'PRN' and the provider license number, denoted by an Identifier.type.coding.code of 'LN'. Conformance Rule: The Provider Registry identifier SHALL be sent if the practioner is the initiating practitioner for the tasks in a message. The Provider Registry identifier SHOULD be sent if known if the practitioner is being sent for other purposes (e.g. the prescriber of a prescription for which a renewal is being sought). When transmitting the provider license number (always mandatory), the Identifier.type shall have a coding from the 'http://hl7.org/fhir/v2/0203' system of 'LN'. For the specific license type expressed as a urn (e.g. urn:oid:1.2.3.4). In a future version of this specification, we may be migrating from OIDs to more readable URL’s. You can plan for this in your design. Conformance Rule: The second identifier provided will be the licence ID of the Prescriber. The assigning authority OID will be determined based on the licencing body; a list of which is found within the Vendor Implementation guide. |
identifier (registry) | 1..1 | Identifier | Definition: An identifier that applies to this person in this role. Comments: This is the same id as found on Practitioner.id, but expressed as a business identifier - it will remain the same as the Practitioner resource is stored on different systems. In the context of Pharmacist Adapt (p170) and Pharmacist Prescribe (p190), no value will exist as pharmacists are not registered. |
type | 1..1 | Shared Health CodeableConcept Code | Binding: IdentifierType (20210501) (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"PRN"}]} Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: |
system | 1..1 | uri | Fixed Value: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner Definition: Establishes the namespace in which set of possible id values is unique. Comments: Fixed value: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner |
value | 1..1 | string | Example' General': 123456 Definition: The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments: Conformance Rule: This SHALL match the practitioner.id value. |
identifier (license) | 0..10 | Identifier | Definition: An identifier that applies to this person in this role. Comments: Conformance Rule: Only a single licence number can be submitted. For Prescriber's with multiple licence numbers, the licence number must be the one that the Prescriber is acting under the authority of when Prescribing. In the context of Pharmacist Adapt (p170) and Pharmacist Prescribe (p190), populate with Pharmacist licensing body and license number |
type | 1..1 | Shared Health CodeableConcept Code Required and Text Required | Binding: IdentifierType (20210501) (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"LN"}]} Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: |
system | 1..1 | uri | Binding: SharedPractitionerIdentifierType (required) Example' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri Definition: Establishes the namespace in which set of possible id values is unique. Comments: The jurisdictional licensing body (e.g. College of Physicians and Surgeons) that issued the practitioner’s license, chosen from terminology binding (this will be an OID expressed as a URI). |
value | 1..1 | string | Example' General': 123456 Definition: The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments: This is the Practitioner license number |
name | 1..1 | Shared Health HumanName | Definition: A human's name with the ability to identify parts and usage. Comments: Usage Note: The last name provided within this segment is validated against the name in the SAML token. It is also used to populate faxes during the “fail to fax” scenario. |
telecom | 0..* | Shared Health ContactPoint | cpt-2: A system is required if a value is provided. Definition: This segment provide methods of contacting the practitioner. Only numbers that have authorized to be disclosed by the practitioner should be included. For example, most practitioners do not authorize the disclosure of their cell phone number to pharmacies. Comments: |
practitionerRole | 0..* | BackboneElement | practitionerRole-1: Must have at least one of organization and role Definition: The list of roles/organizations that the practitioner is associated with. Comments: The address to be used for this PractitionerRole is in the referenced location (removing duplication across all the services provided at the location). |
organization | 0..1 | Reference(Shared Health Organization - Provider Registry) {r} | Definition: A reference from one resource to another. |
reference | 1..1 | string | Definition: This is a reference to the resource within the current bundle that represents the organization the practitioner is working for. Comments: |
role | 0..1 | Shared Health CodeableConcept Code | Binding: SharedPractitionerRole (20190415) (required) Definition: In the context of EMR messages: The prescribers role that is associated to the prescribers license number in the context the clinical event this message is related to. In the context of PMS messages: The prescribers role that is associated to the prescribers license number in the context the event this message is related to. In the context of PR Query Responses: The prescribers role that is associated to the prescribers license number. The prescriber can only have 1 role per license number. Comments: In the context of EMR messages: Conformance Rule: EMR vendors must populate this segment with the associated prescribers role that is related to the license number that is being submitted in the message. The role that is stored and submitted must match the prescribers registered role within the PrescribeIT Provider Registry. In the context of PMS messages: Conformance Rule: PMS vendors should populate this segment with the associated prescribers role that is related to the license number that is being submitted in the message. In the context of Query Response, the prescriber role as associated to the license number will be returned. |
coding | 1..* | Coding | Definition: A reference to a code defined by a terminology system. Comments: |
system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: This is the code as defined within the binding. |
display | 1..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
extension (roleTranslation) | 0..1 | translation | Definition: An expression of the original string in an alternate language. Comments: string-translation elements should not have string-translation extensions (i.e. all translations should be expressed as siblings, not as a translation hierarchy) to simplify processing. |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" |
value[x] | 1..1 | string | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
extension (roleTranslationLanguage) | 1..1 | language | Definition: The language in which the string is expressed. |
specialty | 0..* | Shared Health CodeableConcept Required Text with optional code | Binding: PractitionerSpecialty (example): Specific specialty associated with the agency Definition: The area(s) of medicine that a prescriber specializes in (i.e. Cardiology, Pediatrics, Oncology etc.) Comments: In the context of PR Query Response, at the present time, the prescriber specialty as recorded will be returned as text only in both English and French. Coding will not be returned. Conformance Rule: Vendors must populate this segment with the associated prescribers specialties. If a prescriber does not have a specialty the same value that is sent as the role can be sent as the specialty value. |
coding | 0..1 | Coding | Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: This is the code as defined within the binding. |
text | 1..1 | string | Max Length: 2500 Definition: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Comments: If a free text description of the practitioner’s specialty is available, it must be provided here. If no free text description is available, the value from practitionerRole(practitionerSpecialty).role.coding.display must be provided here. In the context of Pharmacist Adapt (p170) and Pharmacist Prescribe (p190), populate with 'Pharmacist' |
extension (specialtyTranslation) | 0..1 | translation | Definition: An expression of the original string in an alternate language. Comments: string-translation elements should not have string-translation extensions (i.e. all translations should be expressed as siblings, not as a translation hierarchy) to simplify processing. |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" |
value[x] | 1..1 | string | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
extension (specialtyTranslationLanguage) | 1..1 | language | Definition: The language in which the string is expressed. |
communication | 1..* | Shared Health CodeableConcept Code Required with Text Optional | Binding: SharedCommunicationLanguage (20170626) (required) Definition: This will convey the language of the User who is sending the request. Comments: Conformance Rule: Text is optionally supported and if communication is French, can be set to French. In the context of PR Practitioner or Organization Search, this represents the Practitioner's spoken languages (e.g. en-CA for English and fr-CA for French. If both languages are present it means that Practitioner is bilingual. |
This structure is derived from Practitioner
Summary
Mandatory: 12 elements (12 nested mandatory elements)
Must-Support: 36 elements
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-identifier-person
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code-required-text-required
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-humanname
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-contactpoint
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-reference
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-organization-tpr
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-text-required-with-code
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code-required-with-text
Extensions
This structure refers to these extensions:
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service
- http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
- http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Slices
This structure defines the following Slices:
- The element Practitioner.meta.tag is sliced based on the value of value:system
- The element Practitioner.identifier is sliced based on the value of pattern:type
Differential View
This structure is derived from Practitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | S | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services |
id | S | 1..1 | id | Logical id of this artifact |
meta | S | 1..1 | Meta | Metadata about the resource |
tag | S | 1..* | (Slice Definition) | Tags applied to this resource Slice: Unordered, Open by value:system |
tag:version | S | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (20210501) (required) |
system | S | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
code | S | 1..1 | code | Symbol in syntax defined by the system |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-entity-service | S | 0..* | (Complex) | Entity Service URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service |
identifier | S | 0..* | (Slice Definition) | An identifier intended for computation Slice: Unordered, Open by pattern:type |
identifier:registry | S | 1..1 | Identifier | A identifier for the person as this agent |
type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: IdentifierType (20210501) (extensible) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
system | S | 1..1 | uri | The namespace for the identifier Fixed Value: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner |
value | S | 1..1 | string | The value that is unique |
identifier:license | S | 0..10 | Identifier | A identifier for the person as this agent |
type | S | 1..1 | Shared Health CodeableConcept Code Required and Text Required | Concept - reference to a terminology or just text Binding: IdentifierType (20210501) (extensible) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LN | |
system | S | 1..1 | uri | The namespace for the identifier Binding: SharedPractitionerIdentifierType (required) |
value | S | 1..1 | string | The value that is unique |
name | S | 1..1 | Shared Health HumanName | Name of a human - parts and usage |
telecom | S | 0..* | Shared Health ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
practitionerRole | SI | 0..* | BackboneElement | Roles/organizations the practitioner is associated with practitionerRole-1: Must have at least one of organization and role |
organization | SI | 0..1 | Reference(Shared Health Organization - Provider Registry) {r} | A reference from one resource to another |
reference | S | 1..1 | string | Relative, internal or absolute URL reference |
role | SI | 0..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: SharedPractitionerRole (20190415) (required) |
coding | S | 1..* | Coding | Code defined by a terminology system |
display | S | 1..1 | string | Representation defined by the system |
iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
url | S | 1..1 | uri | identifies the meaning of the extension |
value[x] | S | 1..1 | string | Value of extension |
iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
specialty | S | 0..* | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text |
text | S | 1..1 | string | Plain text representation of the concept |
iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
url | S | 1..1 | uri | identifies the meaning of the extension |
value[x] | S | 1..1 | string | Value of extension |
iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
communication | S | 1..* | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text Binding: SharedCommunicationLanguage (20170626) (required) |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | S | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services |
id | SΣ | 1..1 | id | Logical id of this artifact |
meta | SΣ | 1..1 | Meta | Metadata about the resource |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
profile | Σ | 0..* | uri | Profiles this resource claims to conform to |
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
tag | SΣ | 1..* | (Slice Definition) | Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
tag:version | SΣ | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (20210501) (required) |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-entity-service | S | 0..* | (Complex) | Entity Service URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | (Slice Definition) | An identifier intended for computation Slice: Unordered, Open by pattern:type |
identifier:registry | SΣ | 1..1 | Identifier | A identifier for the person as this agent |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: IdentifierType (20210501) (extensible) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
system | SΣ | 1..1 | uri | The namespace for the identifier Fixed Value: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
identifier:license | SΣ | 0..10 | Identifier | A identifier for the person as this agent |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | S | 1..1 | Shared Health CodeableConcept Code Required and Text Required | Concept - reference to a terminology or just text Binding: IdentifierType (20210501) (extensible) Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LN | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
system | SΣ | 1..1 | uri | The namespace for the identifier Binding: SharedPractitionerIdentifierType (required) Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use |
name | S | 1..1 | Shared Health HumanName | Name of a human - parts and usage |
telecom | SI | 0..* | Shared Health ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
address | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
birthDate | Σ | 0..1 | date | The date on which the practitioner was born |
photo | 0..* | Attachment | Image of the person | |
practitionerRole | SI | 0..* | BackboneElement | Roles/organizations the practitioner is associated with practitionerRole-1: Must have at least one of organization and role |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
organization | SI | 0..1 | Reference(Shared Health Organization - Provider Registry) {r} | A reference from one resource to another |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
role | SI | 0..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: SharedPractitionerRole (20190415) (required) |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | SΣ | 1..1 | string | Representation defined by the system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" |
value[x] | S | 1..1 | string | Value of extension |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
specialty | S | 0..* | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text Binding: PractitionerSpecialty (example): Specific specialty associated with the agency |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | SΣ | 0..1 | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | SΣ | 1..1 | string | Plain text representation of the concept Max Length: 2500 |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" |
value[x] | S | 1..1 | string | Value of extension |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location |
telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
location | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | |
healthcareService | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
qualification | 0..* | BackboneElement | Qualifications obtained by training and certification | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | An identifier for this qualification for the practitioner | |
code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 (example): Specific qualification the practitioner has to provide a service | |
period | 0..1 | Period | Period during which the qualification is valid | |
issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |
communication | S | 1..* | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text Binding: SharedCommunicationLanguage (20170626) (required) |
Documentation for this format |
Other representations of profile: Schematron
3.55.3 Terminology Bindings
Terminology Bindings
Path | Conformance | ValueSet / Code |
Practitioner.meta.security | extensible | All Security Labels |
Practitioner.meta.tag | example | |
Practitioner.meta.tag:version | required | SharedSpecificationVersion |
Practitioner.language | required | http://tools.ietf.org/html/bcp47 |
Practitioner.identifier:registry.use | required | IdentifierUse |
Practitioner.identifier:registry.type | extensible | Pattern: PRN |
Practitioner.identifier:license.use | required | IdentifierUse |
Practitioner.identifier:license.type | extensible | Pattern: LN |
Practitioner.identifier:license.system | required | SharedPractitionerIdentifierType |
Practitioner.gender | required | AdministrativeGender |
Practitioner.practitionerRole.role | required | SharedPractitionerRole |
Practitioner.practitionerRole.specialty | example | PractitionerSpecialty |
Practitioner.qualification.code | example | ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 |
Practitioner.communication | required | SharedCommunicationLanguage |
3.55.4 Constraints
Constraints
Id | Path | Details | Requirements |
cpt-2 | Practitioner.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
practitionerRole-1 | Practitioner.practitionerRole | Must have at least one of organization and role : organization.exists() or role.exists() |