Shared Health Specification and Guide Version 5.0

 

The official URL for this profile is:

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

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:
For locum Practitioners, only one identifier - the license number - can be provided as locums are not registered in the Provider Registry.

..  id 1..1idDefinition:
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.


Comments:
Usage Note: This will usually be a GUID and is assigned by the sending application.

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

..  extension
     (locumIndicator)
1..1Practitioner Locum IndicatorDefinition:
An Extension

..  identifier 0..*Shared Health Person IdentifierSlice: Unordered, Open by value:type.coding.system, value:type.coding.code
Definition:
A technical identifier - identifies some entity uniquely and unambiguously.


Comments:
Only the license identifier is expected - 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 registry identifier, the system shall be 'http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner' and the value shall be the provider-registry assigned id (and SHALL be the same value as in Practitioner.id). The Identifier.type shall have a coding from the 'http://hl7.org/fhir/v2/0203' system of 'LR'.



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 (refer to the implementation guide) for the specific license type expressed as a urn (e.g. urn:oid:1.2.3.4). A list of OIDs for different license types can be found in the Vendor Implementation Guide. 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
     (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 CodeBinding: IdentifierType (20210501) (extensible)
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..1uriFixed Value: http://hl7.org/fhir/v2/0203
Definition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
Fixed value: http://hl7.org/fhir/v2/0203

.....  code 1..1codeFixed Value: LN
Definition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
Fixed value: LN

...  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:
Conformance Rule: Set use = Professional; Alias is optional.

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


This structure is derived from Practitioner

Summary

Mandatory: 3 elements (6 nested mandatory elements)
Must-Support: 13 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the values of value:type.coding.system, value:type.coding.code

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 S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-practitioner-locum-indicator S1..1booleanExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-practitioner-locum-indicator
... identifier S0..*(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... identifier:license S0..10IdentifierA identifier for the person as this agent
..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: IdentifierType (20210501) (extensible)
...... coding S1..*CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code S1..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.)

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 S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-practitioner-locum-indicator S1..1booleanExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-practitioner-locum-indicator
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... 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 CodeConcept - reference to a terminology or just text
Binding: IdentifierType (20210501) (extensible)
...... 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
Fixed Value: http://hl7.org/fhir/v2/0203
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: LN
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..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 0..*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 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)
... 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 0..*CodeableConceptA language the practitioner is able to use in patient communication
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.



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:
For locum Practitioners, only one identifier - the license number - can be provided as locums are not registered in the Provider Registry.

..  id 1..1idDefinition:
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.


Comments:
Usage Note: This will usually be a GUID and is assigned by the sending application.

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

..  extension
     (locumIndicator)
1..1Practitioner Locum IndicatorDefinition:
An Extension

..  identifier 0..*Shared Health Person IdentifierSlice: Unordered, Open by value:type.coding.system, value:type.coding.code
Definition:
A technical identifier - identifies some entity uniquely and unambiguously.


Comments:
Only the license identifier is expected - 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 registry identifier, the system shall be 'http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner' and the value shall be the provider-registry assigned id (and SHALL be the same value as in Practitioner.id). The Identifier.type shall have a coding from the 'http://hl7.org/fhir/v2/0203' system of 'LR'.



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 (refer to the implementation guide) for the specific license type expressed as a urn (e.g. urn:oid:1.2.3.4). A list of OIDs for different license types can be found in the Vendor Implementation Guide. 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
     (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 CodeBinding: IdentifierType (20210501) (extensible)
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..1uriFixed Value: http://hl7.org/fhir/v2/0203
Definition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
Fixed value: http://hl7.org/fhir/v2/0203

.....  code 1..1codeFixed Value: LN
Definition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
Fixed value: LN

...  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:
Conformance Rule: Set use = Professional; Alias is optional.

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


This structure is derived from Practitioner

Summary

Mandatory: 3 elements (6 nested mandatory elements)
Must-Support: 13 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the values of value:type.coding.system, value:type.coding.code

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 S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-practitioner-locum-indicator S1..1booleanExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-practitioner-locum-indicator
... identifier S0..*(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... identifier:license S0..10IdentifierA identifier for the person as this agent
..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: IdentifierType (20210501) (extensible)
...... coding S1..*CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code S1..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.)

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 S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-practitioner-locum-indicator S1..1booleanExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-practitioner-locum-indicator
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... 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 CodeConcept - reference to a terminology or just text
Binding: IdentifierType (20210501) (extensible)
...... 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
Fixed Value: http://hl7.org/fhir/v2/0203
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: LN
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..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 0..*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 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)
... 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 0..*CodeableConceptA language the practitioner is able to use in patient communication
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.



doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Practitioner.languagerequiredhttp://tools.ietf.org/html/bcp47
Practitioner.identifier:license.userequiredIdentifierUse
Practitioner.identifier:license.typeextensibleIdentifierType
Practitioner.identifier:license.systemrequiredSharedPractitionerIdentifierType
Practitioner.genderrequiredAdministrativeGender
Practitioner.practitionerRole.roleexamplePractitionerRole
Practitioner.practitionerRole.specialtyexamplePractitionerSpecialty
Practitioner.qualification.codeexampleANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2
Practitioner.communicationrequiredhttp://tools.ietf.org/html/bcp47

Constraints

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