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

Resource Profile: HpiOrganization

Defining URL:http://hl7.org.nz/fhir/StructureDefinition/HpiOrganization
Version:0.2.0
Name:HpiOrganization
Title:HPI Organization
Status:Active as of 2020-10-11T23:44:54+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/StructureDefinition/HpiOrganization

Formal Views of Profile Content

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

This structure is derived from CommonOrganization

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 1 element
Fixed Value: 3 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Organization.identifier is sliced based on the values of value:use, value:system (Open at End)

This structure is derived from CommonOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*CommonOrganizationA grouping of people or organizations with a common purpose
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... organization-established 0..1PeriodThe period over which this Organization has been established
URL: http://hl7.org.nz/fhir/StructureDefinition/organization-established
... identifier 0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open At End by value:use, value:system
.... identifier:dormant S0..*IdentifierIdentifies this organization across multiple systems
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: old
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/id/hpi-org
... alias
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:alias-type 0..1ExtensionThe type of alias for this Organization - eg its Maori name
..... extension 0..0
..... url 1..1uri"alias-type"
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Organization alias types (preferred)
... telecom
.... use 0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
... address 0..0
... contact 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*CommonOrganizationA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... organization-established 0..1PeriodThe period over which this Organization has been established
URL: http://hl7.org.nz/fhir/StructureDefinition/organization-established
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open At End 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 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:dormant SΣI0..*IdentifierIdentifies this organization across multiple systems
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: old
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/id/hpi-org
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... name ΣI0..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:alias-type 0..1ExtensionThe type of alias for this Organization - eg its Maori name
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"alias-type"
..... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Organization alias types (preferred)
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... endpoint 0..*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
... identifier:dormant ΣI0..*IdentifierIdentifies this organization across multiple systems

doco Documentation for this format

This structure is derived from CommonOrganization

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 1 element
Fixed Value: 3 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Organization.identifier is sliced based on the values of value:use, value:system (Open at End)

Differential View

This structure is derived from CommonOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*CommonOrganizationA grouping of people or organizations with a common purpose
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... organization-established 0..1PeriodThe period over which this Organization has been established
URL: http://hl7.org.nz/fhir/StructureDefinition/organization-established
... identifier 0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open At End by value:use, value:system
.... identifier:dormant S0..*IdentifierIdentifies this organization across multiple systems
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: old
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/id/hpi-org
... alias
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:alias-type 0..1ExtensionThe type of alias for this Organization - eg its Maori name
..... extension 0..0
..... url 1..1uri"alias-type"
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Organization alias types (preferred)
... telecom
.... use 0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
... address 0..0
... contact 0..0

doco Documentation for this format

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 Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... organization-established 0..1PeriodThe period over which this Organization has been established
URL: http://hl7.org.nz/fhir/StructureDefinition/organization-established
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open At End 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 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:dormant SΣI0..*IdentifierIdentifies this organization across multiple systems
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: old
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/id/hpi-org
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... name ΣI0..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:alias-type 0..1ExtensionThe type of alias for this Organization - eg its Maori name
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"alias-type"
..... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Organization alias types (preferred)
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... endpoint 0..*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.identifier:dormant.userequiredFixed Value: old
Organization.identifier:dormant.typeextensibleIdentifier Type Codes
Organization.alias.extension:alias-type.value[x]:valueCodeableConceptpreferredOrganizationAliasType
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.contact.purposeextensibleContactEntityType

Constraints

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