New Zealand HPI IG
0.2.0 - CI Build

New Zealand HPI IG, 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: HpiPractitionerRole

Defining URL:http://hl7.org.nz/fhir/StructureDefinition/HpiPractitionerRole
Version:0.2.0
Name:HpiPractitionerRole
Title:HPI Practitioner role
Status:Active as of 2020-10-11T23:44:54+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/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

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... extension 0..*ExtensionExtension
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
.... type 0..0
.... system 0..1uriThe namespace for the identifier value
Binding: Use values for an identifier (required)
... active 0..0
... code 0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRoleCodes (required)
... specialty 0..0
... location 0..1Reference(Location)The location(s) at which this practitioner provides care
... healthcareService 0..0
... telecom
.... use 0..1codehome | 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..1Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
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..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... system Σ0..1uriThe namespace for the identifier value
Binding: Use values for an identifier (required)
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner Σ0..1Reference(Practitioner)Practitioner that is able to provide the defined services for the organization
... organization Σ0..1Reference(Organization)Organization where the roles are available
... code Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRoleCodes (required)
... location Σ0..1Reference(Location)The location(s) at which this practitioner provides care
... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... endpoint 0..1Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

This structure is derived from PractitionerRole

Differential View

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... extension 0..*ExtensionExtension
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
.... type 0..0
.... system 0..1uriThe namespace for the identifier value
Binding: Use values for an identifier (required)
... active 0..0
... code 0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRoleCodes (required)
... specialty 0..0
... location 0..1Reference(Location)The location(s) at which this practitioner provides care
... healthcareService 0..0
... telecom
.... use 0..1codehome | 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..1Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
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..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... system Σ0..1uriThe namespace for the identifier value
Binding: Use values for an identifier (required)
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner Σ0..1Reference(Practitioner)Practitioner that is able to provide the defined services for the organization
... organization Σ0..1Reference(Organization)Organization where the roles are available
... code Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRoleCodes (required)
... location Σ0..1Reference(Location)The location(s) at which this practitioner provides care
... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... endpoint 0..1Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Max Binding: AllLanguages
PractitionerRole.identifier.userequiredIdentifierUse
PractitionerRole.identifier.systemrequiredIdentifierUse
PractitionerRole.coderequiredPractitionerRoleCodes
PractitionerRole.telecom.systemrequiredContactPointSystem
PractitionerRole.telecom.userequiredContactPointUse