New Zealand HPI Implementation Guide, published by David Hay. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions
Resource Profile: HPI Practitioner role
| Defining URL: | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/HpiPractitionerRole |
| Version: | 0.2.0 |
| Name: | HpiPractitionerRole |
| Title: | HPI Practitioner role |
| Status: | Active as of 2021-08-31T02:39:29+00:00 |
| Definition: | The practitioner role exposed by the HPI. Used to connect Practitioners with Organizations and Locations, indicating the role they have. A single Practitioner can have roles with multple organizations. |
| Publisher: | David Hay |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/HpiPractitionerRole
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PractitionerRole
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 practitionerRole-status | 0..1 | (Complex) | The status of this PR - eg is it still active URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status | |
| practitionerRole-creator | 0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
  identifier | ||||
  type | 0..0 | |||
| active | 0..0 | |||
| code | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRoleCodes (required) | |
| specialty | 0..0 | |||
| location | 0..1 | Reference(Location) | The location(s) at which this practitioner provides care | |
| healthcareService | 0..0 | |||
| telecom | ||||
| use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |
| availableTime | 0..0 | |||
| notAvailable | 0..0 | |||
| availabilityExceptions | 0..0 | |||
| endpoint | 0..1 | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| practitionerRole-status | 0..1 | (Complex) | The status of this PR - eg is it still active URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status | |
| practitionerRole-creator | 0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for 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 . |
| 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) |
| period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
| practitioner | Σ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization |
| organization | Σ | 0..1 | Reference(Organization) | Organization where the roles are available |
| code | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRoleCodes (required) |
| location | Σ | 0..1 | Reference(Location) | The location(s) at which this practitioner provides care |
| telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | Σ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) |
| 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 |
| endpoint | 0..1 | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| Documentation for this format | ||||
This structure is derived from PractitionerRole
Differential View
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| practitionerRole-status | 0..1 | (Complex) | The status of this PR - eg is it still active URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status | |
| practitionerRole-creator | 0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
| identifier | ||||
| type | 0..0 | |||
| active | 0..0 | |||
| code | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRoleCodes (required) | |
| specialty | 0..0 | |||
| location | 0..1 | Reference(Location) | The location(s) at which this practitioner provides care | |
| healthcareService | 0..0 | |||
| telecom | ||||
| use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |
| availableTime | 0..0 | |||
| notAvailable | 0..0 | |||
| availabilityExceptions | 0..0 | |||
| endpoint | 0..1 | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| practitionerRole-status | 0..1 | (Complex) | The status of this PR - eg is it still active URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status | |
| practitionerRole-creator | 0..1 | (Complex) | The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for 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 . |
| 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) |
| period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
| practitioner | Σ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization |
| organization | Σ | 0..1 | Reference(Organization) | Organization where the roles are available |
| code | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRoleCodes (required) |
| location | Σ | 0..1 | Reference(Location) | The location(s) at which this practitioner provides care |
| telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | Σ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) |
| 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 |
| endpoint | 0..1 | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| PractitionerRole.language | preferred | CommonLanguages Max Binding: AllLanguages |
| PractitionerRole.identifier.use | required | IdentifierUse |
| PractitionerRole.code | required | PractitionerRoleCodes |
| PractitionerRole.telecom.system | required | ContactPointSystem |
| PractitionerRole.telecom.use | required | ContactPointUse |