Te Whatu Ora, Central Region Integration Hub
1.0.12-rc1 - ci-build
Te Whatu Ora, Central Region Integration Hub
1.0.12-rc1 - ci-build
Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.12-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/crih/StructureDefinition/NZCentralRegionOrganization | Version: 1.0.12-rc1 | |||
| Active as of 2024-09-17 | Computable Name: NZCentralRegionOrganization | |||
Organization resource for Te Whatu Ora, Central Region
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NzOrganization
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization |
C | 0..* | NzOrganization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
  id |
Σ | 0..1 | id | Logical id of this artifact |
  meta |
Σ | 0..1 | Meta | Metadata about the resource |
 id |
0..1 | string | Unique id for inter-element referencing | |
 Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
  process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
 l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| versionId |
Σ | 0..1 | id | Version specific identifier |
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed |
| source |
Σ | 0..1 | uri | Identifies where the resource comes from |
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
 tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣC | 1..* | Identifier | Identifies this organization across multiple systems |
| name |
SΣC | 1..1 | string | Name used for the organization |
 endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Organization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Organization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | |
| Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
This structure is derived from NzOrganization
Summary
Mandatory: 2 elements
Must-Support: 10 elements
Prohibited: 12 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from NzOrganization
Key Elements View
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization |
C | 0..* | NzOrganization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
| id |
Σ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| versionId |
Σ | 0..1 | id | Version specific identifier |
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed |
| source |
Σ | 0..1 | uri | Identifies where the resource comes from |
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣC | 1..* | Identifier | Identifies this organization across multiple systems |
| name |
SΣC | 1..1 | string | Name used for the organization |
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Organization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Organization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | |
| Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
This structure is derived from NzOrganization
Summary
Mandatory: 2 elements
Must-Support: 10 elements
Prohibited: 12 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
Slices for extension