Shared Health Specification and Guide Version 5.0

 

3.78 StructureDefinition: Shared Health Practitioner - 903

The official URL for this profile is: 

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

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

..  name 1..1Shared Health HumanNameDefinition:
A human's name with the ability to identify parts and usage.


Comments:
This data type is used to support both Practitioner names and Patient names. These name values are used for SAML validation (Practitioner) and eFax generation, and possibly patient matching algorithms.



Conformance Rule: For the purpose of presentation, the data elements will be organized as Prefix + Given1 + Given2 + Family + Suffix.

..  practitionerRole 0..*BackboneElementpractitionerRole-1: Must have at least one of organization and role
Definition:
The list of roles/organizations that the practitioner is associated with.


Comments:
The address to be used for this PractitionerRole is in the referenced location (removing duplication across all the services provided at the location).

...  organization 0..1Reference(Shared Health - eRx Service Location) {b}Definition:
A reference from one resource to another.

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


Comments:


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

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
... name S1..1Shared Health HumanNameName of a human - parts and usage
... practitionerRole SI0..*BackboneElementRoles/organizations the practitioner is associated with
practitionerRole-1: Must have at least one of organization and role
.... organization SI0..1Reference(Shared Health - eRx Service Location) {b}A reference from one resource to another
..... reference S1..1stringRelative, internal or absolute URL reference
.... role SI0..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.


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..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA identifier for the person as this agent
... active Σ0..1booleanWhether this practitioner's record is in active use
... name S1..1Shared Health HumanNameName of a human - parts and usage
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... 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 SI0..*BackboneElementRoles/organizations the practitioner is associated with
practitionerRole-1: Must have at least one of organization and role
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... organization SI0..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 SI0..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 Σ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:


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

..  name 1..1Shared Health HumanNameDefinition:
A human's name with the ability to identify parts and usage.


Comments:
This data type is used to support both Practitioner names and Patient names. These name values are used for SAML validation (Practitioner) and eFax generation, and possibly patient matching algorithms.



Conformance Rule: For the purpose of presentation, the data elements will be organized as Prefix + Given1 + Given2 + Family + Suffix.

..  practitionerRole 0..*BackboneElementpractitionerRole-1: Must have at least one of organization and role
Definition:
The list of roles/organizations that the practitioner is associated with.


Comments:
The address to be used for this PractitionerRole is in the referenced location (removing duplication across all the services provided at the location).

...  organization 0..1Reference(Shared Health - eRx Service Location) {b}Definition:
A reference from one resource to another.

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


Comments:


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

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
... name S1..1Shared Health HumanNameName of a human - parts and usage
... practitionerRole SI0..*BackboneElementRoles/organizations the practitioner is associated with
practitionerRole-1: Must have at least one of organization and role
.... organization SI0..1Reference(Shared Health - eRx Service Location) {b}A reference from one resource to another
..... reference S1..1stringRelative, internal or absolute URL reference
.... role SI0..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.


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..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA identifier for the person as this agent
... active Σ0..1booleanWhether this practitioner's record is in active use
... name S1..1Shared Health HumanNameName of a human - parts and usage
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... 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 SI0..*BackboneElementRoles/organizations the practitioner is associated with
practitionerRole-1: Must have at least one of organization and role
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... organization SI0..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 SI0..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 Σ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

3.78.3 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Practitioner.languagerequiredhttp://tools.ietf.org/html/bcp47
Practitioner.genderrequiredAdministrativeGender
Practitioner.practitionerRole.rolerequiredSharedPractitionerRole
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

3.78.4 Constraints

Constraints

IdPathDetailsRequirements
practitionerRole-1Practitioner.practitionerRoleMust have at least one of organization and role
: organization.exists() or role.exists()