New Zealand HPI Implementation Guide
0.2.0 - CI Build

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

Logical Model: ProviderRoleModel - Detailed Descriptions

Definitions for the ProviderRoleModel logical model.

1. ProviderRoleModel
Definition

The role of a provider in a care delivery setting

Control0..* This element is affected by the following invariants: ele-1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. ProviderRoleModel.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
3. ProviderRoleModel.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ProviderRoleModel.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. ProviderRoleModel.provider
Definition

The provider

Control1..1
Typehttp://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel
5. ProviderRoleModel.organization
Definition

The organization that the provide is working for

Control0..1
Typehttp://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel
6. ProviderRoleModel.facility
Definition

The facility where the provider provides care

Control0..1
Typehttp://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel
7. ProviderRoleModel.code
Definition

The role that this provider may perform for the Organization

Control0..1
BindingThe codes SHALL be taken from PractitionerRoleCodes
TypeCodeableConcept
8. ProviderRoleModel.status
Definition

The current status of this role

Control0..1
TypeBackboneElement
9. ProviderRoleModel.status.active
Definition

True if the role is currently active

Control0..1
Typeboolean
10. ProviderRoleModel.status.statusReason
Definition

The reason for the role being in this status

Control0..1
BindingThe codes SHALL be taken from PractitionerRole status reason
TypeCodeableConcept
11. ProviderRoleModel.contactDetails
Definition

How to contact the provider

Control0..*
TypeContactPoint
12. ProviderRoleModel.period
Definition

The period over which the provider is working for the organization

Control0..1
TypePeriod
13. ProviderRoleModel.identifier
Definition

Identifiers assigned to this role

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
14. ProviderRoleModel.creator
Definition

The person who created or updated this resource

Control0..1
TypeBackboneElement
15. ProviderRoleModel.creator.person
Definition

The person making the change

Control1..1
Typehttp://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel
16. ProviderRoleModel.creator.organization
Definition

The organization they are working on behalf on

Control0..1
Typehttp://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel