Shared Health Specification and Guide Version 5.0

 

3.73 StructureDefinition: Shared Health Practitioner

The official URL for this profile is: 

http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner

3.73.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

NameCard.TypeConstraints and Usage
.  Practitioner 0..*PractitionerDefinition:
A person who is directly or indirectly involved in the provisioning of healthcare.


Comments:


..  id 1..1idDefinition:
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.

..  identifier 0..*Shared Health Person IdentifierSlice: 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) 		0..1IdentifierDefinition:
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..1Shared Health CodeableConcept CodeBinding: 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..1uriFixed 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..1stringExample' 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..10IdentifierDefinition:
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..1Shared Health CodeableConcept Code Required and Text RequiredBinding: 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..1uriBinding: 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..1stringExample' 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..1Shared Health HumanNameDefinition:
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 ContactPointcpt-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..*BackboneElementSlice: Unordered, Open by exists:organization
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).

..  practitionerRole
     (practitionerOrg) 		0..*BackboneElementDefinition:
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 1..1Reference(Shared Health - eRx Service Location) {b}Definition:
The organization where the Practitioner performs the roles associated.

....  reference 1..1stringDefinition:
This is a reference to the resource within the current bundle that represents the organization the practitioner is working for.


Comments:


..  practitionerRole
     (practitionerSpecialty) 		0..*BackboneElementDefinition:
The list of roles/organizations that the practitioner is associated with.


Comments:
Usage Note: In the Provider Registry response, all known roles/specialties will be returned.

...  role 0..1Shared Health CodeableConcept CodeBinding: 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..*CodingDefinition:
A reference to a code defined by a terminology system.


Comments:


.....  system 1..1uriDefinition:
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..1codeDefinition:
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..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

......  extension
             (roleTranslation) 		0..1translationDefinition:
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..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
.......  value[x] 1..1stringDefinition:
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..1languageDefinition:
The language in which the string is expressed.

...  specialty 1..*Shared Health CodeableConcept Required Text with optional codeBinding: 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..1CodingDefinition:
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..1uriDefinition:
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..1codeDefinition:
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 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

....  text 1..1stringMax 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..1translationDefinition:
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..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
......  value[x] 1..1stringDefinition:
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..1languageDefinition:
The language in which the string is expressed.

..  communication 1..*Shared Health CodeableConcept Code Required with Text OptionalBinding: 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id S1..1idLogical id of this artifact
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-practitioner-locum-indicator 0..0boolean
... identifier S0..*(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:registry S0..1IdentifierA identifier for the person as this agent
..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: IdentifierType (20210501) (extensible)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
..... system S1..1uriThe namespace for the identifier
Fixed Value: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner
..... value S1..1stringThe value that is unique
.... identifier:license S0..10IdentifierA identifier for the person as this agent
..... type S1..1Shared Health CodeableConcept Code Required and Text RequiredConcept - reference to a terminology or just text
Binding: IdentifierType (20210501) (extensible)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: LN
..... system S1..1uriThe namespace for the identifier
Binding: SharedPractitionerIdentifierType (required)
..... value S1..1stringThe value that is unique
... name S1..1Shared Health HumanNameName of a human - parts and usage
... telecom S0..*Shared Health ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... practitionerRole S0..*(Slice Definition)Roles/organizations the practitioner is associated with
Slice: Unordered, Open by exists:organization
.... practitionerRole:practitionerOrg S0..*BackboneElementRoles/organizations the practitioner is associated with
..... organization S1..1Reference(Shared Health - eRx Service Location) {b}Organization where the roles are performed
...... reference S1..1stringRelative, internal or absolute URL reference
.... practitionerRole:practitionerSpecialty S0..*BackboneElementRoles/organizations the practitioner is associated with
..... organization 0..0
..... role S0..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: SharedPractitionerRole (20190415) (required)
...... coding S1..*CodingCode defined by a terminology system
....... display S1..1stringRepresentation defined by the system
........ iso21090-ST-translation S0..1stringtranslation
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
......... url S1..1uriidentifies the meaning of the extension
......... value[x] S1..1stringValue of extension
.......... iso21090-ST-language S1..1codelanguage
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.

..... specialty S1..*Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
...... text S1..1stringPlain text representation of the concept
....... iso21090-ST-translation S0..1stringtranslation
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
........ url S1..1uriidentifies the meaning of the extension
........ value[x] S1..1stringValue of extension
......... iso21090-ST-language S1..1codelanguage
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.

... communication S1..*Shared Health CodeableConcept Code Required with Text OptionalConcept - reference to a terminology or just text
Binding: SharedCommunicationLanguage (20170626) (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:registry SΣ0..1IdentifierA identifier for the person as this agent
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: IdentifierType (20210501) (extensible)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier
Fixed Value: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:license SΣ0..10IdentifierA identifier for the person as this agent
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type S1..1Shared Health CodeableConcept Code Required and Text RequiredConcept - reference to a terminology or just text
Binding: IdentifierType (20210501) (extensible)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: LN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe 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..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name S1..1Shared Health HumanNameName of a human - parts and usage
... telecom SI0..*Shared Health ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... practitionerRole S0..*(Slice Definition)Roles/organizations the practitioner is associated with
Slice: Unordered, Open by exists:organization
.... practitionerRole:All Slices Content/Rules for all slices
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... organization 0..1Reference(Organization)Organization where the roles are performed
..... role Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example): The role a person plays representing an organization

..... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example): Specific specialty associated with the agency


..... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
..... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
..... period Σ0..1PeriodThe 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:practitionerOrg S0..*BackboneElementRoles/organizations the practitioner is associated with
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... organization S1..1Reference(Shared Health - eRx Service Location) {b}Organization where the roles are performed
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... reference SΣI1..1stringRelative, internal or absolute URL reference
...... display Σ0..1stringText alternative for the resource
..... role Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example): The role a person plays representing an organization

..... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example): Specific specialty associated with the agency


..... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
..... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
..... period Σ0..1PeriodThe 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:practitionerSpecialty S0..*BackboneElementRoles/organizations the practitioner is associated with
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... role S0..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: SharedPractitionerRole (20190415) (required)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... coding SΣ1..*CodingCode defined by a terminology system
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... system SΣ1..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display SΣ1..1stringRepresentation defined by the system
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ iso21090-ST-translation S0..1stringtranslation
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
......... id 0..1idxml:id (or equivalent in JSON)
......... url S1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
......... value[x] S1..1stringValue of extension
.......... id 0..1idxml:id (or equivalent in JSON)
.......... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.......... iso21090-ST-language S1..1codelanguage
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


.......... value 0..1stringPrimitive value for string
Max Length: 1048576
........ value 0..1stringPrimitive value for string
Max Length: 1048576
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... specialty S1..*Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PractitionerSpecialty (example): Specific specialty associated with the agency


...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... coding SΣ0..1CodingCode defined by a terminology system
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... system SΣ1..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display SΣ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text SΣ1..1stringPlain text representation of the concept
Max Length: 2500
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... iso21090-ST-translation S0..1stringtranslation
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
........ id 0..1idxml:id (or equivalent in JSON)
........ url S1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
........ value[x] S1..1stringValue of extension
......... id 0..1idxml:id (or equivalent in JSON)
......... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
......... iso21090-ST-language S1..1codelanguage
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


......... value 0..1stringPrimitive value for string
Max Length: 1048576
....... value 0..1stringPrimitive value for string
Max Length: 1048576
..... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
..... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
..... period Σ0..1PeriodThe 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..*BackboneElementQualifications obtained by training and certification
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded 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..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication S1..*Shared Health CodeableConcept Code Required with Text OptionalConcept - reference to a terminology or just text
Binding: SharedCommunicationLanguage (20170626) (required)

doco Documentation for this format

Grid View

This structure is derived from Practitioner

NameCard.TypeConstraints and Usage
.  Practitioner 0..*PractitionerDefinition:
A person who is directly or indirectly involved in the provisioning of healthcare.


Comments:


..  id 1..1idDefinition:
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.

..  identifier 0..*Shared Health Person IdentifierSlice: 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) 		0..1IdentifierDefinition:
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..1Shared Health CodeableConcept CodeBinding: 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..1uriFixed 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..1stringExample' 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..10IdentifierDefinition:
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..1Shared Health CodeableConcept Code Required and Text RequiredBinding: 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..1uriBinding: 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..1stringExample' 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..1Shared Health HumanNameDefinition:
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 ContactPointcpt-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..*BackboneElementSlice: Unordered, Open by exists:organization
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).

..  practitionerRole
     (practitionerOrg) 		0..*BackboneElementDefinition:
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 1..1Reference(Shared Health - eRx Service Location) {b}Definition:
The organization where the Practitioner performs the roles associated.

....  reference 1..1stringDefinition:
This is a reference to the resource within the current bundle that represents the organization the practitioner is working for.


Comments:


..  practitionerRole
     (practitionerSpecialty) 		0..*BackboneElementDefinition:
The list of roles/organizations that the practitioner is associated with.


Comments:
Usage Note: In the Provider Registry response, all known roles/specialties will be returned.

...  role 0..1Shared Health CodeableConcept CodeBinding: 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..*CodingDefinition:
A reference to a code defined by a terminology system.


Comments:


.....  system 1..1uriDefinition:
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..1codeDefinition:
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..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

......  extension
             (roleTranslation) 		0..1translationDefinition:
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..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
.......  value[x] 1..1stringDefinition:
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..1languageDefinition:
The language in which the string is expressed.

...  specialty 1..*Shared Health CodeableConcept Required Text with optional codeBinding: 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..1CodingDefinition:
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..1uriDefinition:
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..1codeDefinition:
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 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

....  text 1..1stringMax 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..1translationDefinition:
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..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
......  value[x] 1..1stringDefinition:
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..1languageDefinition:
The language in which the string is expressed.

..  communication 1..*Shared Health CodeableConcept Code Required with Text OptionalBinding: 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.

Differential View

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id S1..1idLogical id of this artifact
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-practitioner-locum-indicator 0..0boolean
... identifier S0..*(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:registry S0..1IdentifierA identifier for the person as this agent
..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: IdentifierType (20210501) (extensible)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
..... system S1..1uriThe namespace for the identifier
Fixed Value: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner
..... value S1..1stringThe value that is unique
.... identifier:license S0..10IdentifierA identifier for the person as this agent
..... type S1..1Shared Health CodeableConcept Code Required and Text RequiredConcept - reference to a terminology or just text
Binding: IdentifierType (20210501) (extensible)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: LN
..... system S1..1uriThe namespace for the identifier
Binding: SharedPractitionerIdentifierType (required)
..... value S1..1stringThe value that is unique
... name S1..1Shared Health HumanNameName of a human - parts and usage
... telecom S0..*Shared Health ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... practitionerRole S0..*(Slice Definition)Roles/organizations the practitioner is associated with
Slice: Unordered, Open by exists:organization
.... practitionerRole:practitionerOrg S0..*BackboneElementRoles/organizations the practitioner is associated with
..... organization S1..1Reference(Shared Health - eRx Service Location) {b}Organization where the roles are performed
...... reference S1..1stringRelative, internal or absolute URL reference
.... practitionerRole:practitionerSpecialty S0..*BackboneElementRoles/organizations the practitioner is associated with
..... organization 0..0
..... role S0..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: SharedPractitionerRole (20190415) (required)
...... coding S1..*CodingCode defined by a terminology system
....... display S1..1stringRepresentation defined by the system
........ iso21090-ST-translation S0..1stringtranslation
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
......... url S1..1uriidentifies the meaning of the extension
......... value[x] S1..1stringValue of extension
.......... iso21090-ST-language S1..1codelanguage
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.

..... specialty S1..*Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
...... text S1..1stringPlain text representation of the concept
....... iso21090-ST-translation S0..1stringtranslation
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
........ url S1..1uriidentifies the meaning of the extension
........ value[x] S1..1stringValue of extension
......... iso21090-ST-language S1..1codelanguage
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.

... communication S1..*Shared Health CodeableConcept Code Required with Text OptionalConcept - reference to a terminology or just text
Binding: SharedCommunicationLanguage (20170626) (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:registry SΣ0..1IdentifierA identifier for the person as this agent
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: IdentifierType (20210501) (extensible)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier
Fixed Value: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:license SΣ0..10IdentifierA identifier for the person as this agent
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type S1..1Shared Health CodeableConcept Code Required and Text RequiredConcept - reference to a terminology or just text
Binding: IdentifierType (20210501) (extensible)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: LN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe 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..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name S1..1Shared Health HumanNameName of a human - parts and usage
... telecom SI0..*Shared Health ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... practitionerRole S0..*(Slice Definition)Roles/organizations the practitioner is associated with
Slice: Unordered, Open by exists:organization
.... practitionerRole:All Slices Content/Rules for all slices
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... organization 0..1Reference(Organization)Organization where the roles are performed
..... role Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example): The role a person plays representing an organization

..... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example): Specific specialty associated with the agency


..... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
..... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
..... period Σ0..1PeriodThe 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:practitionerOrg S0..*BackboneElementRoles/organizations the practitioner is associated with
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... organization S1..1Reference(Shared Health - eRx Service Location) {b}Organization where the roles are performed
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... reference SΣI1..1stringRelative, internal or absolute URL reference
...... display Σ0..1stringText alternative for the resource
..... role Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example): The role a person plays representing an organization

..... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example): Specific specialty associated with the agency


..... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
..... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
..... period Σ0..1PeriodThe 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:practitionerSpecialty S0..*BackboneElementRoles/organizations the practitioner is associated with
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... role S0..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: SharedPractitionerRole (20190415) (required)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... coding SΣ1..*CodingCode defined by a terminology system
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... system SΣ1..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display SΣ1..1stringRepresentation defined by the system
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ iso21090-ST-translation S0..1stringtranslation
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
......... id 0..1idxml:id (or equivalent in JSON)
......... url S1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
......... value[x] S1..1stringValue of extension
.......... id 0..1idxml:id (or equivalent in JSON)
.......... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.......... iso21090-ST-language S1..1codelanguage
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


.......... value 0..1stringPrimitive value for string
Max Length: 1048576
........ value 0..1stringPrimitive value for string
Max Length: 1048576
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... specialty S1..*Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PractitionerSpecialty (example): Specific specialty associated with the agency


...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... coding SΣ0..1CodingCode defined by a terminology system
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... system SΣ1..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display SΣ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text SΣ1..1stringPlain text representation of the concept
Max Length: 2500
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... iso21090-ST-translation S0..1stringtranslation
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
........ id 0..1idxml:id (or equivalent in JSON)
........ url S1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
........ value[x] S1..1stringValue of extension
......... id 0..1idxml:id (or equivalent in JSON)
......... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
......... iso21090-ST-language S1..1codelanguage
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


......... value 0..1stringPrimitive value for string
Max Length: 1048576
....... value 0..1stringPrimitive value for string
Max Length: 1048576
..... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
..... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
..... period Σ0..1PeriodThe 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..*BackboneElementQualifications obtained by training and certification
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded 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..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication S1..*Shared Health CodeableConcept Code Required with Text OptionalConcept - reference to a terminology or just text
Binding: SharedCommunicationLanguage (20170626) (required)

doco Documentation for this format

 

Other representations of profile: Schematron

3.73.3 Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Practitioner.languagerequiredhttp://tools.ietf.org/html/bcp47
Practitioner.identifier:registry.userequiredIdentifierUse
Practitioner.identifier:registry.typeextensiblePattern: PRN
Practitioner.identifier:license.userequiredIdentifierUse
Practitioner.identifier:license.typeextensiblePattern: LN
Practitioner.identifier:license.systemrequiredSharedPractitionerIdentifierType
Practitioner.genderrequiredAdministrativeGender
Practitioner.practitionerRole.roleexamplePractitionerRole
Practitioner.practitionerRole.specialtyexamplePractitionerSpecialty
Practitioner.practitionerRole:practitionerOrg.roleexamplePractitionerRole
Practitioner.practitionerRole:practitionerOrg.specialtyexamplePractitionerSpecialty
Practitioner.practitionerRole:practitionerSpecialty.rolerequiredSharedPractitionerRole
Practitioner.practitionerRole:practitionerSpecialty.specialtyexamplePractitionerSpecialty
Practitioner.qualification.codeexampleANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2
Practitioner.communicationrequiredSharedCommunicationLanguage

3.73.4 Constraints

Constraints

IdPathDetailsRequirements
cpt-2Practitioner.telecomA system is required if a value is provided.
: value.empty() or system.exists()