TRxHub IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: TRxHub Practitioner
| Official URL: https://trxhub.mediservice.ch/fhir/StructureDefinition/trxhub-practitioner | Version: 0.1.0 | |||
| Draft as of 2026-10-08 | Computable Name: TRxHubPractitioner | |||
A Practitioner for the TRxHub
Identifier
Identifier must carry an entry for the practitioner's GLN and optionally an entry for the practitioner's ZSR.
Telecom
Telecom must at least contain one entry for email, preferably a HIN email. Optionally, other contact methods can be specified.
Address
Must contain the address of the Practitioner with use work.
Usages:
- Use this Profile: TRxHub Message Bundle and TRxHub Transaction Bundle
- Examples for this Profile: Practitioner/TRxHubPractitionerExample
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
  Slices for identifier |
1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Closed by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   identifier:gln |
1..1 | Identifier | An identifier for the person as this agent | |
  use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | |
 value |
C | 1..1 | string | The value that is unique Constraints: trxhub-prac-gln-length Example General: 123456 |
 identifier:zsr |
0..1 | Identifier | An identifier for the person as this agent | |
 use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | |
| value |
C | 1..1 | string | The value that is unique Constraints: trxhub-prac-zsr-length Example General: 123456 |
 name |
1..1 | HumanName | The name(s) associated with the practitioner | |
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official | |
| family |
1..1 | string | Family name (often called 'Surname') | |
| given |
1..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | |
 prefix |
0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |
| Slices for telecom |
1..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 telecom:All Slices |
Content/Rules for all slices | |||
 system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
1..1 | string | The actual contact point details | |
 use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |
| telecom:email |
1..1 | ContactPoint | A contact detail for the practitioner (that apply to all roles) | |
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email |
| value |
1..1 | string | The actual contact point details | |
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |
 address |
1..1 | Address | Address(es) of the practitioner that are not role specific (typically home address) | |
| use |
1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: work | |
| line |
1..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | |
| city |
1..1 | string | Name of city, town etc. Example General: Erewhon | |
| postalCode |
1..1 | string | Postal code for area Example General: 9132 | |
| country |
1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.identifier:gln.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:zsr.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| trxhub-prac-gln-length | error | Practitioner.identifier:gln.value | GLN must be exactly 13 characters long |
matches('^[0-9]{13}$')
|
| trxhub-prac-zsr-length | error | Practitioner.identifier:zsr.value | ZSR must be exactly one letter and 6 digits long |
matches('^[A-Z][0-9]{6}$')
|
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Practitioner |
Practitioner | |||
| Slices for identifier |
1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Closed by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:gln |
1..1 | Identifier | An identifier for the person as this agent | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | |
| value |
C | 1..1 | string | The value that is unique Constraints: trxhub-prac-gln-length |
| identifier:zsr |
0..1 | Identifier | An identifier for the person as this agent | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | |
| value |
C | 1..1 | string | The value that is unique Constraints: trxhub-prac-zsr-length |
| name |
1..1 | HumanName | The name(s) associated with the practitioner | |
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official | |
| family |
1..1 | string | Family name (often called 'Surname') | |
| given |
1..1 | string | Given names (not always 'first'). Includes middle names | |
| prefix |
0..1 | string | Parts that come before the name | |
| Slices for telecom |
1..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| telecom:All Slices |
Content/Rules for all slices | |||
| system |
1..1 | code | phone | fax | email | pager | url | sms | other | |
| value |
1..1 | string | The actual contact point details | |
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
| telecom:email |
1..1 | ContactPoint | A contact detail for the practitioner (that apply to all roles) | |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
| value |
1..1 | string | The actual contact point details | |
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
| address |
1..1 | Address | Address(es) of the practitioner that are not role specific (typically home address) | |
| use |
1..1 | code | home | work | temp | old | billing - purpose of this address Required Pattern: work | |
| line |
1..1 | string | Street name, number, direction & P.O. Box etc. | |
| city |
1..1 | string | Name of city, town etc. | |
| postalCode |
1..1 | string | Postal code for area | |
| country |
1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Description | Expression |
| trxhub-prac-gln-length | error | Practitioner.identifier:gln.value | GLN must be exactly 13 characters long |
matches('^[0-9]{13}$')
|
| trxhub-prac-zsr-length | error | Practitioner.identifier:zsr.value | ZSR must be exactly one letter and 6 digits long |
matches('^[A-Z][0-9]{6}$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Closed by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:gln |
1..1 | Identifier | An identifier for the person as this agent | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | |||||
| value |
C | 1..1 | string | The value that is unique Constraints: trxhub-prac-gln-length Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
 assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:zsr |
0..1 | Identifier | An identifier for the person as this agent | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | |||||
| value |
C | 1..1 | string | The value that is unique Constraints: trxhub-prac-zsr-length Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| active |
0..1 | boolean | Whether this practitioner's record is in active use | |||||
| name |
1..1 | HumanName | The name(s) associated with the practitioner | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official | |||||
| text |
0..1 | string | Text representation of the full name | |||||
| family |
1..1 | string | Family name (often called 'Surname') | |||||
| given |
1..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | |||||
| prefix |
0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
| suffix |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
| period |
0..1 | Period | Time period when name was/is in use | |||||
| Slices for telecom |
1..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| telecom:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
1..1 | string | The actual contact point details | |||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||
| telecom:email |
1..1 | ContactPoint | A contact detail for the practitioner (that apply to all roles) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
| value |
1..1 | string | The actual contact point details | |||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||
| address |
1..1 | Address | Address(es) of the practitioner that are not role specific (typically home address) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: work | |||||
| type |
0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||
| text |
0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||
| line |
1..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | |||||
| city |
1..1 | string | Name of city, town etc. Example General: Erewhon | |||||
| district |
0..1 | string | District name (aka county) Example General: Madison | |||||
| state |
0..1 | string | Sub-unit of country (abbreviations ok) | |||||
| postalCode |
1..1 | string | Postal code for area Example General: 9132 | |||||
| country |
1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |||||
| period |
0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| birthDate |
0..1 | date | The date on which the practitioner was born | |||||
| photo |
0..* | Attachment | Image of the person | |||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| code |
1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||
| issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:gln.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:gln.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:zsr.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:zsr.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Practitioner.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Practitioner.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Practitioner.qualification.code | Base | example | v2 table 0360, Version 2.7 | 📦0360 | FHIR Std. |
| Practitioner.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| trxhub-prac-gln-length | error | Practitioner.identifier:gln.value | GLN must be exactly 13 characters long |
matches('^[0-9]{13}$')
|
| trxhub-prac-zsr-length | error | Practitioner.identifier:zsr.value | ZSR must be exactly one letter and 6 digits long |
matches('^[A-Z][0-9]{6}$')
|
This structure is derived from Practitioner
Summary
Mandatory: 22 elements(2 nested mandatory elements)
Must-Support: 26 elements
Fixed: 2 elements
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Practitioner.identifier (Closed)
- The element 1 is sliced based on the value of Practitioner.telecom
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Slices for identifier |
1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Closed by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:gln |
1..1 | Identifier | An identifier for the person as this agent | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | |
| value |
C | 1..1 | string | The value that is unique Constraints: trxhub-prac-gln-length Example General: 123456 |
| identifier:zsr |
0..1 | Identifier | An identifier for the person as this agent | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | |
| value |
C | 1..1 | string | The value that is unique Constraints: trxhub-prac-zsr-length Example General: 123456 |
| name |
1..1 | HumanName | The name(s) associated with the practitioner | |
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official | |
| family |
1..1 | string | Family name (often called 'Surname') | |
| given |
1..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | |
| prefix |
0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |
| Slices for telecom |
1..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| telecom:All Slices |
Content/Rules for all slices | |||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
1..1 | string | The actual contact point details | |
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |
| telecom:email |
1..1 | ContactPoint | A contact detail for the practitioner (that apply to all roles) | |
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email |
| value |
1..1 | string | The actual contact point details | |
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |
| address |
1..1 | Address | Address(es) of the practitioner that are not role specific (typically home address) | |
| use |
1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: work | |
| line |
1..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | |
| city |
1..1 | string | Name of city, town etc. Example General: Erewhon | |
| postalCode |
1..1 | string | Postal code for area Example General: 9132 | |
| country |
1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.identifier:gln.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:zsr.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| trxhub-prac-gln-length | error | Practitioner.identifier:gln.value | GLN must be exactly 13 characters long |
matches('^[0-9]{13}$')
|
| trxhub-prac-zsr-length | error | Practitioner.identifier:zsr.value | ZSR must be exactly one letter and 6 digits long |
matches('^[A-Z][0-9]{6}$')
|
Differential View
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Practitioner |
Practitioner | |||
| Slices for identifier |
1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Closed by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:gln |
1..1 | Identifier | An identifier for the person as this agent | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | |
| value |
C | 1..1 | string | The value that is unique Constraints: trxhub-prac-gln-length |
| identifier:zsr |
0..1 | Identifier | An identifier for the person as this agent | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | |
| value |
C | 1..1 | string | The value that is unique Constraints: trxhub-prac-zsr-length |
| name |
1..1 | HumanName | The name(s) associated with the practitioner | |
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official | |
| family |
1..1 | string | Family name (often called 'Surname') | |
| given |
1..1 | string | Given names (not always 'first'). Includes middle names | |
| prefix |
0..1 | string | Parts that come before the name | |
| Slices for telecom |
1..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| telecom:All Slices |
Content/Rules for all slices | |||
| system |
1..1 | code | phone | fax | email | pager | url | sms | other | |
| value |
1..1 | string | The actual contact point details | |
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
| telecom:email |
1..1 | ContactPoint | A contact detail for the practitioner (that apply to all roles) | |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
| value |
1..1 | string | The actual contact point details | |
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
| address |
1..1 | Address | Address(es) of the practitioner that are not role specific (typically home address) | |
| use |
1..1 | code | home | work | temp | old | billing - purpose of this address Required Pattern: work | |
| line |
1..1 | string | Street name, number, direction & P.O. Box etc. | |
| city |
1..1 | string | Name of city, town etc. | |
| postalCode |
1..1 | string | Postal code for area | |
| country |
1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Description | Expression |
| trxhub-prac-gln-length | error | Practitioner.identifier:gln.value | GLN must be exactly 13 characters long |
matches('^[0-9]{13}$')
|
| trxhub-prac-zsr-length | error | Practitioner.identifier:zsr.value | ZSR must be exactly one letter and 6 digits long |
matches('^[A-Z][0-9]{6}$')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Closed by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:gln |
1..1 | Identifier | An identifier for the person as this agent | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.51.1.3 | |||||
| value |
C | 1..1 | string | The value that is unique Constraints: trxhub-prac-gln-length Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:zsr |
0..1 | Identifier | An identifier for the person as this agent | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.756.5.30.1.123.100.2.1.1 | |||||
| value |
C | 1..1 | string | The value that is unique Constraints: trxhub-prac-zsr-length Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| active |
0..1 | boolean | Whether this practitioner's record is in active use | |||||
| name |
1..1 | HumanName | The name(s) associated with the practitioner | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official | |||||
| text |
0..1 | string | Text representation of the full name | |||||
| family |
1..1 | string | Family name (often called 'Surname') | |||||
| given |
1..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | |||||
| prefix |
0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
| suffix |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
| period |
0..1 | Period | Time period when name was/is in use | |||||
| Slices for telecom |
1..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| telecom:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
1..1 | string | The actual contact point details | |||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||
| telecom:email |
1..1 | ContactPoint | A contact detail for the practitioner (that apply to all roles) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
| value |
1..1 | string | The actual contact point details | |||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||
| address |
1..1 | Address | Address(es) of the practitioner that are not role specific (typically home address) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: work | |||||
| type |
0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||
| text |
0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||
| line |
1..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | |||||
| city |
1..1 | string | Name of city, town etc. Example General: Erewhon | |||||
| district |
0..1 | string | District name (aka county) Example General: Madison | |||||
| state |
0..1 | string | Sub-unit of country (abbreviations ok) | |||||
| postalCode |
1..1 | string | Postal code for area Example General: 9132 | |||||
| country |
1..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |||||
| period |
0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| birthDate |
0..1 | date | The date on which the practitioner was born | |||||
| photo |
0..* | Attachment | Image of the person | |||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| code |
1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||
| issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:gln.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:gln.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:zsr.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:zsr.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Practitioner.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Practitioner.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Practitioner.qualification.code | Base | example | v2 table 0360, Version 2.7 | 📦0360 | FHIR Std. |
| Practitioner.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| trxhub-prac-gln-length | error | Practitioner.identifier:gln.value | GLN must be exactly 13 characters long |
matches('^[0-9]{13}$')
|
| trxhub-prac-zsr-length | error | Practitioner.identifier:zsr.value | ZSR must be exactly one letter and 6 digits long |
matches('^[A-Z][0-9]{6}$')
|
This structure is derived from Practitioner
Summary
Mandatory: 22 elements(2 nested mandatory elements)
Must-Support: 26 elements
Fixed: 2 elements
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Practitioner.identifier (Closed)
- The element 1 is sliced based on the value of Practitioner.telecom
Other representations of profile: CSV, Excel, Schematron