NHSD Implementation Guide - Outbound
4.0.1 - active
NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitioner | Version: 4.0.1 | |||
| Draft as of 2017-10-25 | Computable Name: NHSDPratitioner | |||
Copyright/Legal: National Health Services Directory© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
A National Health Services Directory (NHSD) Practitioner
An extended resource providing additional information on the Practitioner not offered by the AU-BASE.
NHSD Provider directory entry for a Practitioner. In a provider directory this provides details of an individual person delivering health related services.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDPractitioner | Australian Practitioner Directory Entry | |
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() |
Σ | 1..1 | Meta | Metadata about Practitioner resource |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
Σ | 1..1 | instant | The timestamp when the resource was last updated |
![]() ![]() |
Σ | 0..* | Identifier | NHSD Practitioner identifiers Slice: Unordered, Open by pattern:type, value:system |
![]() ![]() ![]() |
Σ | 0..1 | AUAHPRARegistrationNumber | An identifier for the person as this agent |
![]() ![]() ![]() |
SΣ | 0..1 | NHSDResourceIdentifier | An identifier for the person as this agent |
![]() ![]() |
SΣ | 1..1 | boolean | Required status |
![]() ![]() |
Σ | 1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Open At End by value:use |
![]() ![]() ![]() |
SΣ | 1..* | HumanName | Usual practitioner name |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: Common Languages in Australia (preferred): A human language. | |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Practitioner.identifier:hpii.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:hpii.type | required | Pattern Value: NPIhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.identifier:medicarePrescriberNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:medicarePrescriberNumber.type | required | Pattern Value: PREShttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.identifier:careAgencyEmployeeIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:ahpraRegistration.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:ahpraRegistration.type | required | Pattern Value: AHPRAhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.name:directory-practitioner-name.use | required | Fixed Value: usualhttp://hl7.org/fhir/ValueSet/name-use|4.0.0From 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 | |
| Practitioner.qualification:ahpraRegistration.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.qualification:ahpraRegistration.identifier.type | required | Pattern Value: AHPRAhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.qualification:ahpraRegistration.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 | |
| Practitioner.communication | preferred | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| 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()) | |
| inv-ahpra-1 | error | Practitioner.qualification:ahpraRegistration.identifier | AHPRA registration value shall be 3 uppercase letters, followed by 10 digits : value.matches('^[A-Z]{3}[0-9]{10}$') |
This structure is derived from AUPDPractitioner
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDPractitioner | Australian Practitioner Directory Entry | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
1..1 | Meta | Metadata about Practitioner resource | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | instant | The timestamp when the resource was last updated | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..* | Identifier | NHSD Practitioner identifiers Slice: Unordered, Open by | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..1 | AUAHPRARegistrationNumber | An identifier for the person as this agent | |
![]() ![]() ![]() |
S | 0..1 | NHSDResourceIdentifier | An identifier for the person as this agent |
![]() ![]() |
1..1 | boolean | Required status | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: Common Languages in Australia (preferred): A human language. | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.communication | preferred | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDPractitioner | Australian Practitioner Directory Entry | |
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() |
Σ | 1..1 | Meta | Metadata about Practitioner resource |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
Σ | 1..1 | instant | The timestamp when the resource was last updated |
![]() ![]() |
Σ | 0..* | Identifier | NHSD Practitioner identifiers Slice: Unordered, Open by pattern:type, value:system |
![]() ![]() ![]() |
Σ | 0..1 | AUAHPRARegistrationNumber | An identifier for the person as this agent |
![]() ![]() ![]() |
SΣ | 0..1 | NHSDResourceIdentifier | An identifier for the person as this agent |
![]() ![]() |
SΣ | 1..1 | boolean | Required status |
![]() ![]() |
Σ | 1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Open At End by value:use |
![]() ![]() ![]() |
SΣ | 1..* | HumanName | Usual practitioner name |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use |
![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: Common Languages in Australia (preferred): A human language. | |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Practitioner.identifier:hpii.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:hpii.type | required | Pattern Value: NPIhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.identifier:medicarePrescriberNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:medicarePrescriberNumber.type | required | Pattern Value: PREShttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.identifier:careAgencyEmployeeIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:careAgencyEmployeeIdentifier.type | required | http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.identifier:ahpraRegistration.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:ahpraRegistration.type | required | Pattern Value: AHPRAhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.name:directory-practitioner-name.use | required | Fixed Value: usualhttp://hl7.org/fhir/ValueSet/name-use|4.0.0From the FHIR Standard | |
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.0From 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 | |
| Practitioner.qualification:ahpraRegistration.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.qualification:ahpraRegistration.identifier.type | required | Pattern Value: AHPRAhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.qualification:ahpraRegistration.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 | |
| Practitioner.qualification:ahpraRegistration.issuer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Practitioner.communication | preferred | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| 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()) | |
| inv-ahpra-1 | error | Practitioner.qualification:ahpraRegistration.identifier | AHPRA registration value shall be 3 uppercase letters, followed by 10 digits : value.matches('^[A-Z]{3}[0-9]{10}$') |
This structure is derived from AUPDPractitioner
Summary
Mandatory: 4 elements
Must-Support: 1 element
Prohibited: 22 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDPractitioner | Australian Practitioner Directory Entry | |
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() |
Σ | 1..1 | Meta | Metadata about Practitioner resource |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
Σ | 1..1 | instant | The timestamp when the resource was last updated |
![]() ![]() |
Σ | 0..* | Identifier | NHSD Practitioner identifiers Slice: Unordered, Open by pattern:type, value:system |
![]() ![]() ![]() |
Σ | 0..1 | AUAHPRARegistrationNumber | An identifier for the person as this agent |
![]() ![]() ![]() |
SΣ | 0..1 | NHSDResourceIdentifier | An identifier for the person as this agent |
![]() ![]() |
SΣ | 1..1 | boolean | Required status |
![]() ![]() |
Σ | 1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Open At End by value:use |
![]() ![]() ![]() |
SΣ | 1..* | HumanName | Usual practitioner name |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: Common Languages in Australia (preferred): A human language. | |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Practitioner.identifier:hpii.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:hpii.type | required | Pattern Value: NPIhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.identifier:medicarePrescriberNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:medicarePrescriberNumber.type | required | Pattern Value: PREShttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.identifier:careAgencyEmployeeIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:ahpraRegistration.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:ahpraRegistration.type | required | Pattern Value: AHPRAhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.name:directory-practitioner-name.use | required | Fixed Value: usualhttp://hl7.org/fhir/ValueSet/name-use|4.0.0From 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 | |
| Practitioner.qualification:ahpraRegistration.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.qualification:ahpraRegistration.identifier.type | required | Pattern Value: AHPRAhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.qualification:ahpraRegistration.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 | |
| Practitioner.communication | preferred | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| 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()) | |
| inv-ahpra-1 | error | Practitioner.qualification:ahpraRegistration.identifier | AHPRA registration value shall be 3 uppercase letters, followed by 10 digits : value.matches('^[A-Z]{3}[0-9]{10}$') |
Differential View
This structure is derived from AUPDPractitioner
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDPractitioner | Australian Practitioner Directory Entry | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
1..1 | Meta | Metadata about Practitioner resource | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | instant | The timestamp when the resource was last updated | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..* | Identifier | NHSD Practitioner identifiers Slice: Unordered, Open by | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..1 | AUAHPRARegistrationNumber | An identifier for the person as this agent | |
![]() ![]() ![]() |
S | 0..1 | NHSDResourceIdentifier | An identifier for the person as this agent |
![]() ![]() |
1..1 | boolean | Required status | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: Common Languages in Australia (preferred): A human language. | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.communication | preferred | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDPractitioner | Australian Practitioner Directory Entry | |
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() |
Σ | 1..1 | Meta | Metadata about Practitioner resource |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
Σ | 1..1 | instant | The timestamp when the resource was last updated |
![]() ![]() |
Σ | 0..* | Identifier | NHSD Practitioner identifiers Slice: Unordered, Open by pattern:type, value:system |
![]() ![]() ![]() |
Σ | 0..1 | AUAHPRARegistrationNumber | An identifier for the person as this agent |
![]() ![]() ![]() |
SΣ | 0..1 | NHSDResourceIdentifier | An identifier for the person as this agent |
![]() ![]() |
SΣ | 1..1 | boolean | Required status |
![]() ![]() |
Σ | 1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Open At End by value:use |
![]() ![]() ![]() |
SΣ | 1..* | HumanName | Usual practitioner name |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use |
![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: Common Languages in Australia (preferred): A human language. | |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Practitioner.identifier:hpii.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:hpii.type | required | Pattern Value: NPIhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.identifier:medicarePrescriberNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:medicarePrescriberNumber.type | required | Pattern Value: PREShttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.identifier:careAgencyEmployeeIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:careAgencyEmployeeIdentifier.type | required | http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.identifier:ahpraRegistration.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.identifier:ahpraRegistration.type | required | Pattern Value: AHPRAhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.name:directory-practitioner-name.use | required | Fixed Value: usualhttp://hl7.org/fhir/ValueSet/name-use|4.0.0From the FHIR Standard | |
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.0From 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 | |
| Practitioner.qualification:ahpraRegistration.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Practitioner.qualification:ahpraRegistration.identifier.type | required | Pattern Value: AHPRAhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 | |
| Practitioner.qualification:ahpraRegistration.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 | |
| Practitioner.qualification:ahpraRegistration.issuer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Practitioner.communication | preferred | CommonLanguagesInAustralia ![]() https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| 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()) | |
| inv-ahpra-1 | error | Practitioner.qualification:ahpraRegistration.identifier | AHPRA registration value shall be 3 uppercase letters, followed by 10 digits : value.matches('^[A-Z]{3}[0-9]{10}$') |
This structure is derived from AUPDPractitioner
Summary
Mandatory: 4 elements
Must-Support: 1 element
Prohibited: 22 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
| Operation | Format | Example |
|---|---|---|
| Read | GET [base]/Practitioner/[id] | GET [base]/Practitioner/bd9fb7ed-3a80-4951-90a4-cb2ef4e815b7 |
| search | POST [base]/Practitioner/_search |
IMPORTANT NOTES ON SEARCH BEHAVIOUR
NHSD recommends search using POST with for complex search scenarios.
For further information and examples, refer to the capability statement
Read: Practitioner
Read identified practitioner resource content.
GET [base]/Practitioner/[id]
Example:
GET [base]/Practitioner/bd9fb7ed-3a80-4951-90a4-cb2ef4e815b7
Support: Read Practitioner
Implementation Notes:
Search by Practitioner Name
Search based on family, given and/or any name.
GET [base]/Practitioner?family=[string]
GET [base]/Practitioner?family=[string]&given=[string]
GET [base]/Practitioner?name=[string]
Example:
GET [base]/Practitioner?family=Phillip
GET [base]/Practitioner?family=Phillip&given=David
GET [base]/Practitioner?name=Brown
Support: Search by family, given and name.
Implementation Notes:
Pagination
GET [base]/Practitioner?_format=json&page=1&_count=10
Refer to the capability statement for further details on paging support through Bundle.Links