Northern Region Implementation Guide
0.2.0 - CI Build
Northern Region Implementation Guide
0.2.0 - CI Build
Northern Region Implementation Guide, published by healthAlliance. 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/northernRegion/ and changes regularly. See the Directory of published versions
Represents Organization data exposed through the Northern Region APIs. The profile extends the NZ Base profile
The official URL for this profile is:
http://hl7.org.nz/fhir/StructureDefinition/NrOrganization
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CommonOrganization
This structure is derived from CommonOrganization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization | 0..* | CommonOrganization | A grouping of people or organizations with a common purpose | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | CommonOrganization | A grouping of people or organizations with a common purpose |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
  identifier | ΣI | 0..* | (Slice Definition) | Identifies this organization across multiple systems Slice: Unordered, Open by value:use, value:system |
   identifier:orgId | SΣI | 0..* | Identifier | The current HPI organization Id for this Organization |
  id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) Fixed Value: official |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
  assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!ΣI | 0..1 | boolean | Whether the organization's record is still in active use |
| type | ΣI | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example) |
| name | ΣI | 0..1 | string | Name used for the organization |
| alias | I | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past |
| telecom | I | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
| address | I | 0..* | CommonAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| partOf | ΣI | 0..1 | Reference(Organization) | The organization of which this organization forms a part |
| contact | I | 0..* | BackboneElement | Contact for the organization for a certain purpose |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| purpose | I | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) |
| name | I | 0..1 | HumanName | A name associated with the contact |
| telecom | I | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
 address | I | 0..1 | Address | Visiting or postal addresses for the contact |
| endpoint | I | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | CommonOrganization | A grouping of people or organizations with a common purpose |
| identifier:orgId | ΣI | 0..* | Identifier | The current HPI organization Id for this Organization |
| Documentation for this format | ||||
This structure is derived from CommonOrganization
Differential View
This structure is derived from CommonOrganization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | 0..* | CommonOrganization | A grouping of people or organizations with a common purpose | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | CommonOrganization | A grouping of people or organizations with a common purpose |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | (Slice Definition) | Identifies this organization across multiple systems Slice: Unordered, Open by value:use, value:system |
| identifier:orgId | SΣI | 0..* | Identifier | The current HPI organization Id for this Organization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) Fixed Value: official |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!ΣI | 0..1 | boolean | Whether the organization's record is still in active use |
| type | ΣI | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example) |
| name | ΣI | 0..1 | string | Name used for the organization |
| alias | I | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past |
| telecom | I | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
| address | I | 0..* | CommonAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| partOf | ΣI | 0..1 | Reference(Organization) | The organization of which this organization forms a part |
| contact | I | 0..* | BackboneElement | Contact for the organization for a certain purpose |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| purpose | I | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) |
| name | I | 0..1 | HumanName | A name associated with the contact |
| telecom | I | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
| address | I | 0..1 | Address | Visiting or postal addresses for the contact |
| endpoint | I | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization |
| Documentation for this format | ||||
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.type | example | OrganizationType |
| 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() |