Shared Health Specification and Guide Version 2.0 Revision F

 

The official URL for this profile is:

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

Download Excel representation

Description of Profiles, Differentials, Snapshots and how the different presentations work.

>

This structure is derived from Shared Health Practitioner

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

..  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

..  extension
     (SAMLToken)
1..1Practitioner SAML TokenDefinition:
The SAML token used to confirm the identity of the practitioner


Comments:
none

..  identifier 0..*Shared Health Person IdentifierSlice: 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)
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.

...  type 1..1Shared Health CodeableConcept CodeBinding: 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..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 and corresponds with the tail of the URL returned from the Provider Registry query

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

...  type 1..1Shared Health CodeableConcept Code Required and Text RequiredBinding: 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..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:
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..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 human-displayable license number

..  name 1..1Shared Health HumanNameDefinition:
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 ContactPointcpt-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..*BackboneElementSlice: 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..*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:
A reference from one resource to another.

....  reference 1..1stringDefinition:
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..*BackboneElementDefinition:
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..1Shared Health CodeableConcept CodeBinding: 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..*CodingDefinition:
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:
.....  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).

.....  display 1..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

......  extension
             (role-translation)
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.

.......  valueString 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
                 (role-translation-language)
1..1languageDefinition:
The language in which the string is expressed.

...  specialty 1..*Shared Health CodeableConcept Required Text with optional codeBinding: 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..*CodingDefinition:
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:
.....  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).

....  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:
Very often the text is the same as a displayName of one of the codings.

.....  extension
           (specialty-translation)
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.

......  valueString 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
               (specialty-translation-language)
1..1languageDefinition:
The language in which the string is expressed.

..  communication 1..*Shared Health CodeableConcept CodeBinding: 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: 1 element
Must-Support: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S0..*A 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-practitioner-saml S1..1AttachmentSAML Token
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-practitioner-saml
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣShared Health Person IdentifierAn identifier intended for computation
Slice: Unordered, Open by value:type
... identifier 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)
.... type S1..1Shared Health CodeableConcept CodeConcept - 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..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 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)
.... type S1..1Shared Health CodeableConcept Code Required and Text RequiredConcept - 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..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)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... practitionerRole SBackboneElementRoles/organizations the practitioner is associated with
Slice: Unordered, Open by exists:organization
.... 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)
.... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
.... 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 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}A reference from one resource to another
..... 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)
.... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
.... 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 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 (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 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
........ valueString 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)
......... value 0..1Primitive value for string
Max Length: 1048576
....... value 0..1Primitive 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)
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding SΣ0..*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 Σ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 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
....... valueString 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)
........ value 0..1Primitive value for string
Max Length: 1048576
...... value 0..1Primitive 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)
.... 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 CodeConcept - reference to a terminology or just text
Binding: SharedCommunicationLanguage (required)

doco Documentation for this format

Grid View

This structure is derived from Shared Health Practitioner

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

..  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

..  extension
     (SAMLToken)
1..1Practitioner SAML TokenDefinition:
The SAML token used to confirm the identity of the practitioner


Comments:
none

..  identifier 0..*Shared Health Person IdentifierSlice: 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)
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.

...  type 1..1Shared Health CodeableConcept CodeBinding: 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..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 and corresponds with the tail of the URL returned from the Provider Registry query

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

...  type 1..1Shared Health CodeableConcept Code Required and Text RequiredBinding: 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..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:
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..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 human-displayable license number

..  name 1..1Shared Health HumanNameDefinition:
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 ContactPointcpt-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..*BackboneElementSlice: 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..*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:
A reference from one resource to another.

....  reference 1..1stringDefinition:
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..*BackboneElementDefinition:
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..1Shared Health CodeableConcept CodeBinding: 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..*CodingDefinition:
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:
.....  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).

.....  display 1..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

......  extension
             (role-translation)
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.

.......  valueString 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
                 (role-translation-language)
1..1languageDefinition:
The language in which the string is expressed.

...  specialty 1..*Shared Health CodeableConcept Required Text with optional codeBinding: 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..*CodingDefinition:
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:
.....  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).

....  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:
Very often the text is the same as a displayName of one of the codings.

.....  extension
           (specialty-translation)
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.

......  valueString 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
               (specialty-translation-language)
1..1languageDefinition:
The language in which the string is expressed.

..  communication 1..*Shared Health CodeableConcept CodeBinding: 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: 1 element
Must-Support: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S0..*A 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-practitioner-saml S1..1AttachmentSAML Token
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-practitioner-saml
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣShared Health Person IdentifierAn identifier intended for computation
Slice: Unordered, Open by value:type
... identifier 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)
.... type S1..1Shared Health CodeableConcept CodeConcept - 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..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 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)
.... type S1..1Shared Health CodeableConcept Code Required and Text RequiredConcept - 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..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)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... practitionerRole SBackboneElementRoles/organizations the practitioner is associated with
Slice: Unordered, Open by exists:organization
.... 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)
.... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
.... 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 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}A reference from one resource to another
..... 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)
.... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
.... 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 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 (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 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
........ valueString 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)
......... value 0..1Primitive value for string
Max Length: 1048576
....... value 0..1Primitive 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)
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding SΣ0..*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 Σ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 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation"
....... valueString 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)
........ value 0..1Primitive value for string
Max Length: 1048576
...... value 0..1Primitive 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)
.... 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 CodeConcept - reference to a terminology or just text
Binding: SharedCommunicationLanguage (required)

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathNameConformanceValueSet
Practitioner.language?extrequiredhttp://tools.ietf.org/html/bcp47
Practitioner.identifier.useIdentifierUserequiredIdentifierUse
Practitioner.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Practitioner.identifier.useIdentifierUserequiredIdentifierUse
Practitioner.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Practitioner.identifier.systemSharedPractitionerIdentifierTyperequiredSharedPractitionerIdentifierType
Practitioner.genderAdministrativeGenderrequiredAdministrativeGender
Practitioner.practitionerRole.roleSharedPractitionerRolerequiredSharedPractitionerRole
Practitioner.practitionerRole.specialtyPractitionerSpecialtyexamplePractitionerSpecialty
Practitioner.practitionerRole.roleSharedPractitionerRolerequiredSharedPractitionerRole
Practitioner.practitionerRole.specialtyPractitionerSpecialtyexamplePractitionerSpecialty
Practitioner.practitionerRole.roleSharedPractitionerRolerequiredSharedPractitionerRole
Practitioner.practitionerRole.specialtyPractitionerSpecialtyexamplePractitionerSpecialty
Practitioner.qualification.codeANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2exampleANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2
Practitioner.communicationSharedCommunicationLanguagerequiredSharedCommunicationLanguage

Constraints

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