Te Whatu Ora, Central Region Integration Hub
1.0.10-rc1 - ci-build
Te Whatu Ora, Central Region Integration Hub
1.0.10-rc1 - ci-build
Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.10-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/crih/StructureDefinition/NZCentralRegionPractitioner | Version: 1.0.10-rc1 | |||
| Active as of 2024-09-04 | Computable Name: NZCentralRegionPractitioner | |||
Practitioner resource for Te Whatu Ora, Central Region
A skeleton of the FHIR resource Practitioner. It is created / updated by incoming Patient demographic (HL7 ADT A30) messages.
Many fields are not supported, and have been marked with zero cardinality 0..0 and strikethrough font in the differential table.
Should be treated as placeholder resources.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NzPractitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner |
0..* | NzPractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
  meta |
||||
   extension |
1..* | Extension | Extension | |
 Slices for extension |
Content/Rules for all slices | |||
  hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
  url |
1..1 | uri | identifies the meaning of the extension | |
 value[x] |
0..1 | base64Binary | Value of extension | |
| Slices for extension |
Content/Rules for all slices | |||
 process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| Slices for extension |
Content/Rules for all slices | |||
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| Slices for extension |
Content/Rules for all slices | |||
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| Slices for extension |
Content/Rules for all slices | |||
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| Slices for extension |
Content/Rules for all slices | |||
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| Slices for extension |
Content/Rules for all slices | |||
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
 Slices for extension |
Content/Rules for all slices | |||
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| implicitRules |
0..0 | |||
| language |
0..0 | |||
| contained |
0..0 | |||
| Slices for extension |
Content/Rules for all slices | |||
 extension:death-date |
0..0 | |||
| extension:educational-qualification |
0..0 | |||
| extension:ethnicity |
0..0 | |||
| extension:iwi |
0..0 | |||
| identifier |
S | 1..* | Identifier | An identifier for the person as this agent |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |
| type |
||||
| coding |
0..* | Coding | Code defined by a terminology system | |
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
 display |
0..1 | string | Representation defined by the system | |
| system |
0..1 | uri | The namespace for the identifier value | |
| value |
0..1 | string | The value that is unique | |
| active |
S | 0..0 | ||
| name |
S | 1..* | HumanName | The name(s) associated with the practitioner |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | official | nickname |
| text |
S | 1..1 | string | Text representation of the full name |
| family |
S | 1..1 | string | Family name (often called 'Surname') |
| given |
S | 0..* | string | Given names (not always 'first'). Includes middle names |
| prefix |
S | 0..* | string | Parts that come before the name |
| suffix |
0..0 | |||
| telecom |
0..0 | |||
| address |
0..0 | |||
| gender |
0..0 | |||
| birthDate |
0..0 | |||
| photo |
0..0 | |||
| qualification |
0..0 | |||
| communication |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | NzPractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
 meta |
Σ | 0..1 | Meta | Metadata about the resource |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
 extension |
0..0 | |||
 url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| Slices for extension |
Content/Rules for all slices | |||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 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 |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| name |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | official | nickname Binding: NameUse (required): The use of a human name. |
| text |
SΣ | 1..1 | string | Text representation of the full name |
| family |
SΣ | 1..1 | string | Family name (often called 'Surname') |
| given |
SΣ | 0..* | 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 |
SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | |
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | NzPractitioner | 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 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| versionId |
Σ | 0..1 | id | Version specific identifier |
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed |
| source |
Σ | 0..1 | uri | Identifies where the resource comes from |
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 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. |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| 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 |
Σ | 0..1 | uri | Identity of the terminology system |
| version |
Σ | 0..1 | string | Version of the system - if relevant |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 0..1 | string | The value that is unique 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) |
| name |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | official | nickname Binding: NameUse (required): The use of a human name. |
| text |
SΣ | 1..1 | string | Text representation of the full name |
| family |
SΣ | 1..1 | string | Family name (often called 'Surname') |
| given |
SΣ | 0..* | 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 |
SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| period |
Σ | 0..1 | Period | Time period when name was/is in use |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Practitioner.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | |
| Practitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Practitioner.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | |
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from NzPractitioner
Summary
Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 18 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from NzPractitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | NzPractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| meta |
||||
| extension |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| Slices for extension |
Content/Rules for all slices | |||
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| Slices for extension |
Content/Rules for all slices | |||
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| Slices for extension |
Content/Rules for all slices | |||
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| Slices for extension |
Content/Rules for all slices | |||
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| Slices for extension |
Content/Rules for all slices | |||
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| Slices for extension |
Content/Rules for all slices | |||
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| Slices for extension |
Content/Rules for all slices | |||
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| implicitRules |
0..0 | |||
| language |
0..0 | |||
| contained |
0..0 | |||
| Slices for extension |
Content/Rules for all slices | |||
| extension:death-date |
0..0 | |||
| extension:educational-qualification |
0..0 | |||
| extension:ethnicity |
0..0 | |||
| extension:iwi |
0..0 | |||
| identifier |
S | 1..* | Identifier | An identifier for the person as this agent |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |
| type |
||||
| coding |
0..* | Coding | Code defined by a terminology system | |
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| system |
0..1 | uri | The namespace for the identifier value | |
| value |
0..1 | string | The value that is unique | |
| active |
S | 0..0 | ||
| name |
S | 1..* | HumanName | The name(s) associated with the practitioner |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | official | nickname |
| text |
S | 1..1 | string | Text representation of the full name |
| family |
S | 1..1 | string | Family name (often called 'Surname') |
| given |
S | 0..* | string | Given names (not always 'first'). Includes middle names |
| prefix |
S | 0..* | string | Parts that come before the name |
| suffix |
0..0 | |||
| telecom |
0..0 | |||
| address |
0..0 | |||
| gender |
0..0 | |||
| birthDate |
0..0 | |||
| photo |
0..0 | |||
| qualification |
0..0 | |||
| communication |
0..0 | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | NzPractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| Slices for extension |
Content/Rules for all slices | |||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 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 |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| name |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | official | nickname Binding: NameUse (required): The use of a human name. |
| text |
SΣ | 1..1 | string | Text representation of the full name |
| family |
SΣ | 1..1 | string | Family name (often called 'Surname') |
| given |
SΣ | 0..* | 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 |
SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | |
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner |
0..* | NzPractitioner | 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 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| versionId |
Σ | 0..1 | id | Version specific identifier |
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed |
| source |
Σ | 0..1 | uri | Identifies where the resource comes from |
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 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. |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| 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 |
Σ | 0..1 | uri | Identity of the terminology system |
| version |
Σ | 0..1 | string | Version of the system - if relevant |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 0..1 | string | The value that is unique 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) |
| name |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | official | nickname Binding: NameUse (required): The use of a human name. |
| text |
SΣ | 1..1 | string | Text representation of the full name |
| family |
SΣ | 1..1 | string | Family name (often called 'Surname') |
| given |
SΣ | 0..* | 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 |
SΣ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| period |
Σ | 0..1 | Period | Time period when name was/is in use |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Practitioner.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | |
| Practitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Practitioner.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | |
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from NzPractitioner
Summary
Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 18 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron