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
Defining URL: | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/HpiOrganization |
Version: | 0.2.0 |
Name: | HpiOrganization |
Title: | HPI Organization |
Status: | Active as of 2020-11-25T23:08:15+00:00 |
Definition: | An entity that provides services of interest to, or is involved in, the business of health care service provision. |
Publisher: | David Hay |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/HpiOrganization
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organization
Summary
Mandatory: 4 elements (4 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 6 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Organization
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Organization | A grouping of people or organizations with a common purpose | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Period | The period over which this Organization has been established URL: http://hl7.org.nz/fhir/StructureDefinition/organization-established | |
![]() ![]() ![]() | 1..* | (Slice Definition) | Identifies this organization across multiple systems Slice: Unordered, Open At End by value:use, value:system | |
![]() ![]() ![]() ![]() | S | 1..1 | Identifier | The current HPI organization Id for this Organization |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id | |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | The MOH (NZHIS) Legacy agency code) |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id | |
![]() ![]() ![]() ![]() | S | 0..* | Identifier | Identifies this organization across multiple systems |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: old | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/id/hpi-org | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Organization | A grouping of people or organizations with a common purpose |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Period | The period over which this Organization has been established URL: http://hl7.org.nz/fhir/StructureDefinition/organization-established | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ΣI | 1..* | (Slice Definition) | Identifies this organization across multiple systems Slice: Unordered, Open At End by value:use, value:system |
![]() ![]() ![]() ![]() | SΣI | 1..1 | Identifier | The current HPI organization Id for this Organization |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | SΣI | 0..1 | Identifier | The MOH (NZHIS) Legacy agency code) |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | SΣI | 0..* | Identifier | Identifies this organization across multiple systems |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/id/hpi-org |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() ![]() | ΣI | 0..1 | string | Name used for the organization |
![]() ![]() ![]() | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
![]() ![]() ![]() | I | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) |
![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part |
![]() ![]() ![]() | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Organization | A grouping of people or organizations with a common purpose |
![]() ![]() ![]() | ΣI | 1..1 | Identifier | The current HPI organization Id for this Organization |
![]() ![]() ![]() | ΣI | 0..1 | Identifier | The MOH (NZHIS) Legacy agency code) |
![]() ![]() ![]() | ΣI | 0..* | Identifier | Identifies this organization across multiple systems |
![]() |
This structure is derived from Organization
Summary
Mandatory: 4 elements (4 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 6 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Organization
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Organization | A grouping of people or organizations with a common purpose | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Period | The period over which this Organization has been established URL: http://hl7.org.nz/fhir/StructureDefinition/organization-established | |
![]() ![]() ![]() | 1..* | (Slice Definition) | Identifies this organization across multiple systems Slice: Unordered, Open At End by value:use, value:system | |
![]() ![]() ![]() ![]() | S | 1..1 | Identifier | The current HPI organization Id for this Organization |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id | |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | The MOH (NZHIS) Legacy agency code) |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id | |
![]() ![]() ![]() ![]() | S | 0..* | Identifier | Identifies this organization across multiple systems |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: old | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/id/hpi-org | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Organization | A grouping of people or organizations with a common purpose |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Period | The period over which this Organization has been established URL: http://hl7.org.nz/fhir/StructureDefinition/organization-established | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ΣI | 1..* | (Slice Definition) | Identifies this organization across multiple systems Slice: Unordered, Open At End by value:use, value:system |
![]() ![]() ![]() ![]() | SΣI | 1..1 | Identifier | The current HPI organization Id for this Organization |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | SΣI | 0..1 | Identifier | The MOH (NZHIS) Legacy agency code) |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | SΣI | 0..* | Identifier | Identifies this organization across multiple systems |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/id/hpi-org |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() ![]() | ΣI | 0..1 | string | Name used for the organization |
![]() ![]() ![]() | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
![]() ![]() ![]() | I | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) |
![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part |
![]() ![]() ![]() | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
![]() |
Other representations of profile: Schematron
Path | Conformance | ValueSet / Code |
Organization.language | preferred | CommonLanguages Max Binding: AllLanguages |
Organization.identifier:orgId.use | required | Fixed Value: official |
Organization.identifier:orgId.type | extensible | Identifier Type Codes |
Organization.identifier:legacyOrgId.use | required | Fixed Value: official |
Organization.identifier:legacyOrgId.type | extensible | Identifier Type Codes |
Organization.identifier:dormant.use | required | Fixed Value: old |
Organization.identifier:dormant.type | extensible | Identifier Type Codes |
Organization.telecom.system | required | ContactPointSystem |
Organization.telecom.use | required | ContactPointUse |
Organization.contact.purpose | extensible | ContactEntityType |
Id | Path | Details | Requirements |
org-3 | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |