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

Resource Profile: NrOrganization

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

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CommonOrganization

Summary

This structure is derived from CommonOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*CommonOrganizationA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by value:use, value:system
.... identifier:orgId SΣI0..*IdentifierThe current HPI organization Id for this Organization
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether the organization's record is still in active use
... type ΣI0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name ΣI0..1stringName used for the organization
... alias I0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address I0..*CommonAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf ΣI0..1Reference(Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose I0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name I0..1HumanNameA name associated with the contact
.... telecom I0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address I0..1AddressVisiting or postal addresses for the contact
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*CommonOrganizationA grouping of people or organizations with a common purpose
... identifier:orgId ΣI0..*IdentifierThe current HPI organization Id for this Organization

doco Documentation for this format

This structure is derived from CommonOrganization

Summary

Differential View

This structure is derived from CommonOrganization

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*CommonOrganizationA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by value:use, value:system
.... identifier:orgId SΣI0..*IdentifierThe current HPI organization Id for this Organization
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether the organization's record is still in active use
... type ΣI0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name ΣI0..1stringName used for the organization
... alias I0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address I0..*CommonAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf ΣI0..1Reference(Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose I0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name I0..1HumanNameA name associated with the contact
.... telecom I0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address I0..1AddressVisiting or postal addresses for the contact
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Organization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Organization.identifier:orgId.userequiredFixed Value: official
Organization.identifier:orgId.typeextensibleIdentifier Type Codes
Organization.typeexampleOrganizationType
Organization.contact.purposeextensibleContactEntityType

Constraints

IdPathDetailsRequirements
org-3Organization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()