New Zealand HPI Implementation Guide
0.9.0 - CI Build
New Zealand HPI Implementation Guide, published by Ministry of Health. This is not an authorized publication; it is the continuous build for version 0.9.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions
JSON representation of the ProviderRoleModel logical model.
{
"resourceType" : "StructureDefinition",
"id" : "ProviderRoleModel",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Minimum and Maximum # of times the the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/R4/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel\" title=\"The role of a provider in a care delivery setting\">ProviderRoleModel</a><a name=\"ProviderRoleModel\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#Element\">Element</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Provider role</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel.provider\" title=\"The provider\">provider</a><a name=\"ProviderRoleModel.provider\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ProviderModel.html\">http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The provider</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel.organization\" title=\"The organization that the provide is working for\">organization</a><a name=\"ProviderRoleModel.organization\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-OrganizationModel.html\">http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The organization that the provide is working for</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel.facility\" title=\"The facility where the provider provides care\">facility</a><a name=\"ProviderRoleModel.facility\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-FacilityModel.html\">http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The facility where the provider provides care</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel.code\" title=\"The role that this provider may perform for the Organization\">code</a><a name=\"ProviderRoleModel.code\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The role that this provider may perform for the Organization<br/><span style=\"font-weight:bold\">Binding: </span><a href=\"ValueSet-Hpi-practitioner-role.html\">PractitonerRole code</a> (<a href=\"http://hl7.org/fhir/R4/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\">required</a>)</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck11.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel.status\" title=\"The current status of this role\">status</a><a name=\"ProviderRoleModel.status\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#BackboneElement\">BackboneElement</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The current status of this role</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel.status.active\" title=\"True if the role is currently active\">active</a><a name=\"ProviderRoleModel.status.active\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">True if the role is currently active</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck100.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel.status.statusReason\" title=\"The reason for the role being in this status\">statusReason</a><a name=\"ProviderRoleModel.status.statusReason\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The reason for the role being in this status<br/><span style=\"font-weight:bold\">Binding: </span><a href=\"https://build.fhir.org/ig/HL7NZ/nzbase//ValueSet-hpi-practitionerrole-status-reason.html\">PractitionerRole status reason</a> (<a href=\"http://hl7.org/fhir/R4/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\">required</a>)</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel.contactDetails\" title=\"How to contact the provider\">contactDetails</a><a name=\"ProviderRoleModel.contactDetails\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..*</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#ContactPoint\">ContactPoint</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">How to contact the provider<br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel.period\" title=\"The period over which the provider is working for the organization\">period</a><a name=\"ProviderRoleModel.period\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#Period\">Period</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The period over which the provider is working for the organization</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel.identifier\" title=\"Identifiers assigned to this role\">identifier</a><a name=\"ProviderRoleModel.identifier\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..*</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Identifiers assigned to this role<br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel.creator\" title=\"The person who created or updated this resource\">creator</a><a name=\"ProviderRoleModel.creator\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#BackboneElement\">BackboneElement</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The person who created or updated this resource</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck010.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel.creator.person\" title=\"The person making the change\">person</a><a name=\"ProviderRoleModel.creator.person\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ProviderModel.html\">http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The person making the change</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ProviderRoleModel-definitions.html#ProviderRoleModel.creator.organization\" title=\"The organization they are working on behalf on\">organization</a><a name=\"ProviderRoleModel.creator.organization\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-OrganizationModel.html\">http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The organization they are working on behalf on</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/R4/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderRoleModel",
"version" : "0.9.0",
"name" : "ProviderRoleModel",
"title" : "Provider role",
"status" : "active",
"date" : "2021-12-03T02:22:27+00:00",
"publisher" : "Ministry of Health",
"contact" : [
{
"name" : "Ministry of Health",
"telecom" : [
{
"system" : "email",
"value" : "mailto:integration@health.govt.nz"
}
]
}
],
"description" : "The role of a provider in a care delivery setting",
"fhirVersion" : "4.0.1",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderRoleModel",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Element",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "ProviderRoleModel",
"path" : "ProviderRoleModel",
"short" : "Provider role",
"definition" : "The role of a provider in a care delivery setting",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element",
"min" : 0,
"max" : "*"
},
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ProviderRoleModel.id",
"path" : "ProviderRoleModel.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ProviderRoleModel.extension",
"path" : "ProviderRoleModel.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"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.",
"comment" : "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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ProviderRoleModel.provider",
"path" : "ProviderRoleModel.provider",
"short" : "The provider",
"definition" : "The provider",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ProviderRoleModel.provider",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel"
}
]
},
{
"id" : "ProviderRoleModel.organization",
"path" : "ProviderRoleModel.organization",
"short" : "The organization that the provide is working for",
"definition" : "The organization that the provide is working for",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ProviderRoleModel.organization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel"
}
]
},
{
"id" : "ProviderRoleModel.facility",
"path" : "ProviderRoleModel.facility",
"short" : "The facility where the provider provides care",
"definition" : "The facility where the provider provides care",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ProviderRoleModel.facility",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel"
}
]
},
{
"id" : "ProviderRoleModel.code",
"path" : "ProviderRoleModel.code",
"short" : "The role that this provider may perform for the Organization",
"definition" : "The role that this provider may perform for the Organization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ProviderRoleModel.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code"
}
},
{
"id" : "ProviderRoleModel.status",
"path" : "ProviderRoleModel.status",
"short" : "The current status of this role",
"definition" : "The current status of this role",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ProviderRoleModel.status",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "BackboneElement"
}
]
},
{
"id" : "ProviderRoleModel.status.active",
"path" : "ProviderRoleModel.status.active",
"short" : "True if the role is currently active",
"definition" : "True if the role is currently active",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ProviderRoleModel.status.active",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "ProviderRoleModel.status.statusReason",
"path" : "ProviderRoleModel.status.statusReason",
"short" : "The reason for the role being in this status",
"definition" : "The reason for the role being in this status",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ProviderRoleModel.status.statusReason",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/hpi-practitioner-role-status-reason-code"
}
},
{
"id" : "ProviderRoleModel.contactDetails",
"path" : "ProviderRoleModel.contactDetails",
"short" : "How to contact the provider",
"definition" : "How to contact the provider",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ProviderRoleModel.contactDetails",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "ContactPoint"
}
]
},
{
"id" : "ProviderRoleModel.period",
"path" : "ProviderRoleModel.period",
"short" : "The period over which the provider is working for the organization",
"definition" : "The period over which the provider is working for the organization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ProviderRoleModel.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
]
},
{
"id" : "ProviderRoleModel.identifier",
"path" : "ProviderRoleModel.identifier",
"short" : "Identifiers assigned to this role",
"definition" : "Identifiers assigned to this role",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ProviderRoleModel.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
]
},
{
"id" : "ProviderRoleModel.creator",
"path" : "ProviderRoleModel.creator",
"short" : "The person who created or updated this resource",
"definition" : "The person who created or updated this resource",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ProviderRoleModel.creator",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "BackboneElement"
}
]
},
{
"id" : "ProviderRoleModel.creator.person",
"path" : "ProviderRoleModel.creator.person",
"short" : "The person making the change",
"definition" : "The person making the change",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ProviderRoleModel.creator.person",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel"
}
]
},
{
"id" : "ProviderRoleModel.creator.organization",
"path" : "ProviderRoleModel.creator.organization",
"short" : "The organization they are working on behalf on",
"definition" : "The organization they are working on behalf on",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ProviderRoleModel.creator.organization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "ProviderRoleModel",
"path" : "ProviderRoleModel",
"short" : "Provider role",
"definition" : "The role of a provider in a care delivery setting"
},
{
"id" : "ProviderRoleModel.provider",
"path" : "ProviderRoleModel.provider",
"short" : "The provider",
"definition" : "The provider",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel"
}
]
},
{
"id" : "ProviderRoleModel.organization",
"path" : "ProviderRoleModel.organization",
"short" : "The organization that the provide is working for",
"definition" : "The organization that the provide is working for",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel"
}
]
},
{
"id" : "ProviderRoleModel.facility",
"path" : "ProviderRoleModel.facility",
"short" : "The facility where the provider provides care",
"definition" : "The facility where the provider provides care",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel"
}
]
},
{
"id" : "ProviderRoleModel.code",
"path" : "ProviderRoleModel.code",
"short" : "The role that this provider may perform for the Organization",
"definition" : "The role that this provider may perform for the Organization",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code"
}
},
{
"id" : "ProviderRoleModel.status",
"path" : "ProviderRoleModel.status",
"short" : "The current status of this role",
"definition" : "The current status of this role",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "BackboneElement"
}
]
},
{
"id" : "ProviderRoleModel.status.active",
"path" : "ProviderRoleModel.status.active",
"short" : "True if the role is currently active",
"definition" : "True if the role is currently active",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "ProviderRoleModel.status.statusReason",
"path" : "ProviderRoleModel.status.statusReason",
"short" : "The reason for the role being in this status",
"definition" : "The reason for the role being in this status",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/hpi-practitioner-role-status-reason-code"
}
},
{
"id" : "ProviderRoleModel.contactDetails",
"path" : "ProviderRoleModel.contactDetails",
"short" : "How to contact the provider",
"definition" : "How to contact the provider",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "ContactPoint"
}
]
},
{
"id" : "ProviderRoleModel.period",
"path" : "ProviderRoleModel.period",
"short" : "The period over which the provider is working for the organization",
"definition" : "The period over which the provider is working for the organization",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Period"
}
]
},
{
"id" : "ProviderRoleModel.identifier",
"path" : "ProviderRoleModel.identifier",
"short" : "Identifiers assigned to this role",
"definition" : "Identifiers assigned to this role",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "Identifier"
}
]
},
{
"id" : "ProviderRoleModel.creator",
"path" : "ProviderRoleModel.creator",
"short" : "The person who created or updated this resource",
"definition" : "The person who created or updated this resource",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "BackboneElement"
}
]
},
{
"id" : "ProviderRoleModel.creator.person",
"path" : "ProviderRoleModel.creator.person",
"short" : "The person making the change",
"definition" : "The person making the change",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/ProviderModel"
}
]
},
{
"id" : "ProviderRoleModel.creator.organization",
"path" : "ProviderRoleModel.creator.organization",
"short" : "The organization they are working on behalf on",
"definition" : "The organization they are working on behalf on",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel"
}
]
}
]
}
}