HL7® FHIR® New Zealand Base Implementation Guide
3.0.0 - Release

HL7® FHIR® New Zealand Base Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions

Resource Profile: PractitionerRole resource for use in NZ

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzPractitionerRole Version: 1.0.0
Draft as of 2023-12-04 Realm: New Zealand flag Computable Name: NzPractitionerRole

PractitionerRole resource for use in NZ

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1idLogical 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... practitionerRole-creator 0..1(Complex)Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator
... practitionerRole-status-reason 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason
Binding: PractitionerRole status reason (preferred)
... messaging-address 0..*(Complex)Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
... active Σ0..1booleanWhether this practitioner role record is in active use
... 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..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example): The role a person plays representing an organization.


... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.


... location Σ0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.codeexamplePractitionerRole
PractitionerRole.specialtypreferredPracticeSettingCodeValueSet
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1idLogical 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... practitionerRole-creator 0..1(Complex)Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator
... practitionerRole-status-reason 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason
Binding: PractitionerRole status reason (preferred)
... messaging-address 0..*(Complex)Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
... active Σ0..1booleanWhether this practitioner role record is in active use
... 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..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example): The role a person plays representing an organization.


... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.


... location Σ0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.codeexamplePractitionerRole
PractitionerRole.specialtypreferredPracticeSettingCodeValueSet
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

 

Other representations of profile: CSV, Excel, Schematron