3.53 StructureDefinition: Shared Health Practitioner - Provider Registry
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner-tpr
3.53.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 Shared Health Practitioner
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Practitioner | 0..* | Definition: A person who is directly or indirectly involved in the provisioning of healthcare. Comments: In Practitioner two identifiers can be provided. One for the issued Provider Registry Number, and the second for License Number. | |
 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: Conformance Note: This will be the Provider Registry identifier if the practitioner is the sending practitioner (and may be for other practitioners). If the Provider Registry identifier is not known (e.g. renewing a prescription from a non-e-prescribing clinician), a local identifier assigned by the sending application may be used instead. Ideally, this identifier will be consistent for all messages referencing the same 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) 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 (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 value: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'. The system will be a standard OID that can be found on the terminology gateway, here: 'https://tgateway.infoway-inforoute.ca/html/singlesubset.html?id=2.16.840.1.113883.2.20.3.423&versionid=20170626'. 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. HL7 Mapping Rule: This maps to Author and Data Enterer for Prescriber-Initiated Interactions 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. |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: Identifier Type Codes (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: Distinguishes this repetition as the Provider Registry identifier. For this codeable concept coding and text is supported. For coding refer to child elements for fixed values. |
| 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 and corresponds with the tail of the URL returned from the Provider Registry query |
| 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. |
| type | 1..1 | Shared Health CodeableConcept Code Required and Text Required | Binding: Identifier Type Codes (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: Distinguishes this repetition as the license number For this codeable concept, 'coding' and 'text' is supported. For coding refer to child elements for fixed values. |
| 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: Provincial licensing body. Usage Note: This will be an OID expressed as a URI (e.g. urn:oid:1.2.3.4). In the future version, we may be migrating from OIDs to more readable URL’s. This must be populated with a value from the Shared Health Practitioner College Identifier value set. |
| 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 human-displayable license number |
| name | 1..1 | Shared Health HumanName | Definition: A human's name with the ability to identify parts and usage. Comments: Usage Note: Last name is validated against the name in the SAML. It is also required for eFax. Conformance Rule: This Must be populated with the Provider Registry assigned Prescriber name as returned in the Provider Registry Query Response. Conformance Rule: Legal name is mandatory. Set use = Professional; Alias is optional Conformance Rule: Mandatory for Transactions initiated by a PMS; else not used. |
| telecom | 0..* | Shared Health ContactPoint | cpt-2: A system is required if a value is provided. Definition: Used to convey the number than can be used to contact the prescriber if the pharmacy needs to contact the prescriber directly. Only numbers that have authorized to be disclosed by the prescriber should be included. For example, most prescribers do not authorize the disclosure of their cell phone number to pharmacies. Comments: Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification These typically will have home numbers, or mobile numbers that are not role specific. |
| practitionerRole | 0..* | BackboneElement | Slice: Unordered, Open by exists:organization Definition: The list of roles/organizations that the practitioner is associated with. Comments: Conformance Rule: For MedDialog, the Practitioner Role (organization) is not supported as the organization is specified in the extension 'OnBehalfOf'. For ePrescribing, only a single Organization should be included; that being the organization that is relevant for the message being sent. |
| practitionerRole (practitionerOrg) | 0..* | BackboneElement | 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). |
| 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: Conformance Rule: This will be populated when a practitioner enrolls for services individually for each organization that he/she is assocaited with. 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. |
| organization | 1..1 | Reference(Shared Health Organization - Provider Registry) {b} | Definition: A reference from one resource to another. |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| practitionerRole (practitionerSpecialty) | 0..* | BackboneElement | Definition: The list of roles/organizations that the practitioner is associated with. Comments: In the context of SAML Practitioner, Practitioner.practitionerRole.specialty.text should be populate if known. If not, Practitioner.practitionerRole.role.coding.display must be populated. Usage Note: In the Provider Registry response, all known roles/specialties will be returned. |
| role | 0..1 | Shared Health CodeableConcept Code | Binding: SharedPractitionerRole (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: |
 coding | 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: |
| 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). |
| display | 1..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| extension (role-translation) | 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. |
| valueString | 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 (role-translation-language) | 1..1 | language | Definition: The language in which the string is expressed. |
| specialty | 1..* | Shared Health CodeableConcept Required Text with optional code | Binding: PractitionerSpecialty (example) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: In the context of PR Query Response, at the present time, coding will not be provided. Text will be populated in both French and English. |
| coding | 0..* | 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: |
| 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). |
| 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: Very often the text is the same as a displayName of one of the codings. |
| extension (specialty-translation) | 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. |
| valueString | 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 (specialty-translation-language) | 1..1 | language | Definition: The language in which the string is expressed. |
| communication | 1..* | Shared Health CodeableConcept Code | Binding: SharedCommunicationLanguage (required) Definition: This will convey the language of the User who is sending the request. The language will apply across the entire message unless otherwise indicated. Comments: Conformance Rule: For this codeable concept, both coding and text are optionally supported. Coding.code has a binding value set defined. (en-CA = English, fr-CA = French). Text is optionally supported and if communication is French, can be set to FR. |
This structure is derived from Shared Health Practitioner
Summary
Mandatory: 6 elements (1 nested mandatory element)
Must-Support: 14 elements
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-reference
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-organization-tpr
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element Practitioner.meta.tag is sliced based on the value of value:system
- The element Practitioner.practitionerRole is sliced based on the value of exists:organization
This structure is derived from Shared Health Practitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Practitioner | S | 0..* | ||
| meta | S | 1..1 | Meta | |
 tag | S | Coding | Slice: Unordered, Open by value:system | |
| tag | S | 1..1 | Coding | Binding: SharedSpecificationVersion (required) |
| system | S | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| code | S | 1..1 | code | |
 extension | S | 0..* | 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 | 1..1 | Identifier | |
| practitionerRole | S | BackboneElement | Slice: Unordered, Open by exists:organization | |
| practitionerRole | S | 0..* | BackboneElement | |
| extension | S | 0..* | Extension | Slice: Unordered, Open by value:url |
| ext-entity-service | S | 0..* | (Complex) | Entity Service URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service |
 organization | S | 1..1 | Reference(Shared Health Organization - Provider Registry) {b} | |
| practitionerRole | S | 0..* | BackboneElement | |
| organization | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | S | 0..* | 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) |
| tag | SΣ | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example) | |
| tag | SΣ | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (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) | |
| text | I | 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Σ | Shared Health Person Identifier | An identifier intended for computation Slice: Unordered, Open by value:type | |
| identifier | 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) |
| type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: Identifier Type Codes (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"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 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 | 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) |
| type | S | 1..1 | Shared Health CodeableConcept Code Required and Text Required | Concept - reference to a terminology or just text Binding: Identifier Type Codes (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"LN"}]} |
| 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) |
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born |
| photo | 0..* | Attachment | Image of the person | |
| practitionerRole | S | BackboneElement | Roles/organizations the practitioner is associated with Slice: Unordered, Open by exists:organization | |
 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 | 0..1 | Reference(Organization) | Organization where the roles are performed | |
| role | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example) |
| specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PractitionerSpecialty (example) |
| 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) | |
| practitionerRole | S | 0..* | BackboneElement | Roles/organizations the practitioner is associated with |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| 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 |
| organization | S | 1..1 | Reference(Shared Health Organization - Provider Registry) {b} | 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 | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example) |
| specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PractitionerSpecialty (example) |
| 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) | |
| practitionerRole | S | 0..* | BackboneElement | Roles/organizations the practitioner is associated with |
| 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 |
| role | S | 0..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: SharedPractitionerRole (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 | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" | |
| valueString | 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) |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| value | 0..1 | 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 | 1..* | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text Binding: PractitionerSpecialty (example) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 0..* | 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 | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" | |
| valueString | 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) |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| value | 0..1 | 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) | |
| 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 | Concept - reference to a terminology or just text Binding: SharedCommunicationLanguage (required) |
| Documentation for this format | ||||
Grid View
This structure is derived from Shared Health Practitioner
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Practitioner | 0..* | Definition: A person who is directly or indirectly involved in the provisioning of healthcare. Comments: In Practitioner two identifiers can be provided. One for the issued Provider Registry Number, and the second for License Number. | |
| 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: Conformance Note: This will be the Provider Registry identifier if the practitioner is the sending practitioner (and may be for other practitioners). If the Provider Registry identifier is not known (e.g. renewing a prescription from a non-e-prescribing clinician), a local identifier assigned by the sending application may be used instead. Ideally, this identifier will be consistent for all messages referencing the same 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) 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 (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 value: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'. The system will be a standard OID that can be found on the terminology gateway, here: 'https://tgateway.infoway-inforoute.ca/html/singlesubset.html?id=2.16.840.1.113883.2.20.3.423&versionid=20170626'. 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. HL7 Mapping Rule: This maps to Author and Data Enterer for Prescriber-Initiated Interactions 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. |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: Identifier Type Codes (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: Distinguishes this repetition as the Provider Registry identifier. For this codeable concept coding and text is supported. For coding refer to child elements for fixed values. |
| 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 and corresponds with the tail of the URL returned from the Provider Registry query |
| 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. |
| type | 1..1 | Shared Health CodeableConcept Code Required and Text Required | Binding: Identifier Type Codes (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: Distinguishes this repetition as the license number For this codeable concept, 'coding' and 'text' is supported. For coding refer to child elements for fixed values. |
| 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: Provincial licensing body. Usage Note: This will be an OID expressed as a URI (e.g. urn:oid:1.2.3.4). In the future version, we may be migrating from OIDs to more readable URL’s. This must be populated with a value from the Shared Health Practitioner College Identifier value set. |
| 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 human-displayable license number |
| name | 1..1 | Shared Health HumanName | Definition: A human's name with the ability to identify parts and usage. Comments: Usage Note: Last name is validated against the name in the SAML. It is also required for eFax. Conformance Rule: This Must be populated with the Provider Registry assigned Prescriber name as returned in the Provider Registry Query Response. Conformance Rule: Legal name is mandatory. Set use = Professional; Alias is optional Conformance Rule: Mandatory for Transactions initiated by a PMS; else not used. |
| telecom | 0..* | Shared Health ContactPoint | cpt-2: A system is required if a value is provided. Definition: Used to convey the number than can be used to contact the prescriber if the pharmacy needs to contact the prescriber directly. Only numbers that have authorized to be disclosed by the prescriber should be included. For example, most prescribers do not authorize the disclosure of their cell phone number to pharmacies. Comments: Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification These typically will have home numbers, or mobile numbers that are not role specific. |
| practitionerRole | 0..* | BackboneElement | Slice: Unordered, Open by exists:organization Definition: The list of roles/organizations that the practitioner is associated with. Comments: Conformance Rule: For MedDialog, the Practitioner Role (organization) is not supported as the organization is specified in the extension 'OnBehalfOf'. For ePrescribing, only a single Organization should be included; that being the organization that is relevant for the message being sent. |
| practitionerRole (practitionerOrg) | 0..* | BackboneElement | 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). |
| 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: Conformance Rule: This will be populated when a practitioner enrolls for services individually for each organization that he/she is assocaited with. 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. |
| organization | 1..1 | Reference(Shared Health Organization - Provider Registry) {b} | Definition: A reference from one resource to another. |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| practitionerRole (practitionerSpecialty) | 0..* | BackboneElement | Definition: The list of roles/organizations that the practitioner is associated with. Comments: In the context of SAML Practitioner, Practitioner.practitionerRole.specialty.text should be populate if known. If not, Practitioner.practitionerRole.role.coding.display must be populated. Usage Note: In the Provider Registry response, all known roles/specialties will be returned. |
| role | 0..1 | Shared Health CodeableConcept Code | Binding: SharedPractitionerRole (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: |
| coding | 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: |
| 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). |
| display | 1..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| extension (role-translation) | 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. |
| valueString | 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 (role-translation-language) | 1..1 | language | Definition: The language in which the string is expressed. |
| specialty | 1..* | Shared Health CodeableConcept Required Text with optional code | Binding: PractitionerSpecialty (example) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: In the context of PR Query Response, at the present time, coding will not be provided. Text will be populated in both French and English. |
| coding | 0..* | 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: |
| 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). |
| 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: Very often the text is the same as a displayName of one of the codings. |
| extension (specialty-translation) | 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. |
| valueString | 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 (specialty-translation-language) | 1..1 | language | Definition: The language in which the string is expressed. |
| communication | 1..* | Shared Health CodeableConcept Code | Binding: SharedCommunicationLanguage (required) Definition: This will convey the language of the User who is sending the request. The language will apply across the entire message unless otherwise indicated. Comments: Conformance Rule: For this codeable concept, both coding and text are optionally supported. Coding.code has a binding value set defined. (en-CA = English, fr-CA = French). Text is optionally supported and if communication is French, can be set to FR. |
This structure is derived from Shared Health Practitioner
Summary
Mandatory: 6 elements (1 nested mandatory element)
Must-Support: 14 elements
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-reference
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-organization-tpr
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element Practitioner.meta.tag is sliced based on the value of value:system
- The element Practitioner.practitionerRole is sliced based on the value of exists:organization
Differential View
This structure is derived from Shared Health Practitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | S | 0..* | ||
| meta | S | 1..1 | Meta | |
| tag | S | Coding | Slice: Unordered, Open by value:system | |
| tag | S | 1..1 | Coding | Binding: SharedSpecificationVersion (required) |
| system | S | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| code | S | 1..1 | code | |
| extension | S | 0..* | 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 | 1..1 | Identifier | |
| practitionerRole | S | BackboneElement | Slice: Unordered, Open by exists:organization | |
| practitionerRole | S | 0..* | BackboneElement | |
| extension | S | 0..* | Extension | Slice: Unordered, Open by value:url |
| ext-entity-service | S | 0..* | (Complex) | Entity Service URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-entity-service |
| organization | S | 1..1 | Reference(Shared Health Organization - Provider Registry) {b} | |
| practitionerRole | S | 0..* | BackboneElement | |
| organization | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | S | 0..* | 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) |
| tag | SΣ | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example) | |
| tag | SΣ | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (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) | |
| text | I | 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Σ | Shared Health Person Identifier | An identifier intended for computation Slice: Unordered, Open by value:type | |
| identifier | 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) |
| type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: Identifier Type Codes (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"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 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 | 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) |
| type | S | 1..1 | Shared Health CodeableConcept Code Required and Text Required | Concept - reference to a terminology or just text Binding: Identifier Type Codes (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"LN"}]} |
| 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) |
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born |
| photo | 0..* | Attachment | Image of the person | |
| practitionerRole | S | BackboneElement | Roles/organizations the practitioner is associated with Slice: Unordered, Open by exists:organization | |
| 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 | 0..1 | Reference(Organization) | Organization where the roles are performed | |
| role | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example) |
| specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PractitionerSpecialty (example) |
| 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) | |
| practitionerRole | S | 0..* | BackboneElement | Roles/organizations the practitioner is associated with |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| 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 |
| organization | S | 1..1 | Reference(Shared Health Organization - Provider Registry) {b} | 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 | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example) |
| specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PractitionerSpecialty (example) |
| 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) | |
| practitionerRole | S | 0..* | BackboneElement | Roles/organizations the practitioner is associated with |
| 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 |
| role | S | 0..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: SharedPractitionerRole (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 | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" | |
| valueString | 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) |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| value | 0..1 | 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 | 1..* | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text Binding: PractitionerSpecialty (example) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 0..* | 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 | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" | |
| valueString | 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) |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| value | 0..1 | 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) | |
| 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 | Concept - reference to a terminology or just text Binding: SharedCommunicationLanguage (required) |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.53.3 Terminology Bindings
Terminology Bindings
| Path | Name | Conformance | ValueSet |
| Practitioner.meta.security | All Security Labels | extensible | All Security Labels |
| Practitioner.meta.tag | SharedSpecificationVersion | required | SharedSpecificationVersion |
| Practitioner.meta.tag | SharedSpecificationVersion | required | SharedSpecificationVersion |
| Practitioner.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| Practitioner.identifier.use | IdentifierUse | required | IdentifierUse |
| Practitioner.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
| Practitioner.identifier.use | IdentifierUse | required | IdentifierUse |
| Practitioner.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
| Practitioner.identifier.system | SharedPractitionerIdentifierType | required | SharedPractitionerIdentifierType |
| Practitioner.gender | AdministrativeGender | required | AdministrativeGender |
| Practitioner.practitionerRole.role | SharedPractitionerRole | required | SharedPractitionerRole |
| Practitioner.practitionerRole.specialty | PractitionerSpecialty | example | PractitionerSpecialty |
| Practitioner.practitionerRole.role | SharedPractitionerRole | required | SharedPractitionerRole |
| Practitioner.practitionerRole.specialty | PractitionerSpecialty | example | PractitionerSpecialty |
| Practitioner.practitionerRole.role | SharedPractitionerRole | required | SharedPractitionerRole |
| Practitioner.practitionerRole.specialty | PractitionerSpecialty | example | PractitionerSpecialty |
| Practitioner.qualification.code | ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 | example | ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 |
| Practitioner.communication | SharedCommunicationLanguage | required | SharedCommunicationLanguage |
3.53.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() |