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
Defining URL: | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel |
Version: | 0.9.0 |
Name: | OrganizationModel |
Title: | An Organization involved in healthcare |
Status: | Active as of 12/3/21, 2:22 AM |
Definition: | An Organization involved in healthcare |
Publisher: | Ministry of Health |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Element
This structure is derived from Element
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OrganizationModel | 0..* | Element | An Organization involved in healthcare | |
name | 0..1 | string | The name of the Organization | |
alias | 0..* | BackboneElement | Other names by which this Organization is known | |
name | 1..1 | string | The alternative name | |
type | 0..1 | CodeableConcept | The type of alias - eg locally used name Binding: All the possible alias types (required) | |
hpiOrgId | 1..1 | Identifier | The HPI number assigned to the Organization | |
nzbn | 0..1 | Identifier | New Zealand Business Number | |
dormantOrgId | 0..* | Identifier | Previously assigned identifiers, no longer used | |
otherIdentifiers | 0..* | Identifier | Other identifiers that may have been assigned | |
active | 0..1 | boolean | True if the Organization is currently in operation | |
contactDetails | 0..* | ContactPoint | How to contact the organization (by a human) | |
electronicContactDetails | 0..* | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/EndpointModel | Technical contacts | |
partOf | 0..1 | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel | If this organization is part of a larger one | |
established | 0..1 | Period | The period over which the organization has been / is in operation | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OrganizationModel | 0..* | Element | An Organization involved in healthcare | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
name | 0..1 | string | The name of the Organization | |
alias | 0..* | BackboneElement | Other names by which this Organization is known | |
name | 1..1 | string | The alternative name | |
type | 0..1 | CodeableConcept | The type of alias - eg locally used name Binding: All the possible alias types (required) | |
hpiOrgId | 1..1 | Identifier | The HPI number assigned to the Organization | |
nzbn | 0..1 | Identifier | New Zealand Business Number | |
dormantOrgId | 0..* | Identifier | Previously assigned identifiers, no longer used | |
otherIdentifiers | 0..* | Identifier | Other identifiers that may have been assigned | |
active | 0..1 | boolean | True if the Organization is currently in operation | |
contactDetails | 0..* | ContactPoint | How to contact the organization (by a human) | |
electronicContactDetails | 0..* | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/EndpointModel | Technical contacts | |
partOf | 0..1 | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel | If this organization is part of a larger one | |
established | 0..1 | Period | The period over which the organization has been / is in operation | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OrganizationModel | 0..* | Element | An Organization involved in healthcare | |
Documentation for this format |
This structure is derived from Element
Differential View
This structure is derived from Element
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OrganizationModel | 0..* | Element | An Organization involved in healthcare | |
name | 0..1 | string | The name of the Organization | |
alias | 0..* | BackboneElement | Other names by which this Organization is known | |
name | 1..1 | string | The alternative name | |
type | 0..1 | CodeableConcept | The type of alias - eg locally used name Binding: All the possible alias types (required) | |
hpiOrgId | 1..1 | Identifier | The HPI number assigned to the Organization | |
nzbn | 0..1 | Identifier | New Zealand Business Number | |
dormantOrgId | 0..* | Identifier | Previously assigned identifiers, no longer used | |
otherIdentifiers | 0..* | Identifier | Other identifiers that may have been assigned | |
active | 0..1 | boolean | True if the Organization is currently in operation | |
contactDetails | 0..* | ContactPoint | How to contact the organization (by a human) | |
electronicContactDetails | 0..* | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/EndpointModel | Technical contacts | |
partOf | 0..1 | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel | If this organization is part of a larger one | |
established | 0..1 | Period | The period over which the organization has been / is in operation | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OrganizationModel | 0..* | Element | An Organization involved in healthcare | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
name | 0..1 | string | The name of the Organization | |
alias | 0..* | BackboneElement | Other names by which this Organization is known | |
name | 1..1 | string | The alternative name | |
type | 0..1 | CodeableConcept | The type of alias - eg locally used name Binding: All the possible alias types (required) | |
hpiOrgId | 1..1 | Identifier | The HPI number assigned to the Organization | |
nzbn | 0..1 | Identifier | New Zealand Business Number | |
dormantOrgId | 0..* | Identifier | Previously assigned identifiers, no longer used | |
otherIdentifiers | 0..* | Identifier | Other identifiers that may have been assigned | |
active | 0..1 | boolean | True if the Organization is currently in operation | |
contactDetails | 0..* | ContactPoint | How to contact the organization (by a human) | |
electronicContactDetails | 0..* | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/EndpointModel | Technical contacts | |
partOf | 0..1 | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel | If this organization is part of a larger one | |
established | 0..1 | Period | The period over which the organization has been / is in operation | |
Documentation for this format |
Other representations of profile: CSV, Excel
Path | Conformance | ValueSet |
OrganizationModel.alias.type | required | AliasType |