New Zealand HPI Implementation Guide
0.2.0 - CI Build

New Zealand HPI Implementation Guide, 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

Logical Model: OrganizationModel - Detailed Descriptions

Definitions for the OrganizationModel logical model.

1. OrganizationModel
Definition

An Organization involved in healthcare

Control0..* This element is affected by the following invariants: ele-1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. OrganizationModel.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
3. OrganizationModel.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on OrganizationModel.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. OrganizationModel.name
Definition

The name of the Organization

Control0..1
Typestring
5. OrganizationModel.alias
Definition

Other names by which this Organization is known

Control0..*
TypeBackboneElement
6. OrganizationModel.alias.name
Definition

The alternative name

Control1..1
Typestring
7. OrganizationModel.alias.type
Definition

The type of alias - eg locally used name

Control0..1
BindingThe codes SHALL be taken from All the possible alias types
TypeCodeableConcept
8. OrganizationModel.hpiOrgId
Definition

The HPI number assigned to the Organization

Control1..1
TypeIdentifier
9. OrganizationModel.nzbn
Definition

New Zealand Business Number

Control0..1
TypeIdentifier
10. OrganizationModel.dormantOrgId
Definition

Previously assigned identifiers, no longer used

Control0..*
TypeIdentifier
11. OrganizationModel.otherIdentifiers
Definition

Other identifiers that may have been assigned

Control0..*
TypeIdentifier
12. OrganizationModel.active
Definition

True if the Organization is currently in operation

Control0..1
Typeboolean
13. OrganizationModel.contactDetails
Definition

How to contact the organization (by a human)

Control0..*
TypeContactPoint
14. OrganizationModel.electronicContactDetails
Definition

Technical contacts

Control0..*
Typehttp://hl7.org.nz/fhir/ig/hpi/StructureDefinition/EndpointModel
15. OrganizationModel.partOf
Definition

If this organization is part of a larger one

Control0..1
Typehttp://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel
16. OrganizationModel.established
Definition

The period over which the organization has been / is in operation

Control0..1
TypePeriod