| Package | fhir.org.nz.ig.base |
| Type | StructureDefinition |
| Id | dhb |
| FHIR Version | R4 |
| Source | http://hl7.org.nz/fhir/https://build.fhir.org/ig/HL7NZ/nzbase/StructureDefinition-dhb.html |
| URL | http://hl7.org.nz/fhir/StructureDefinition/dhb |
| Version | 1.0 |
| Status | active |
| Date | 2020-07-31 |
| Name | Dhb |
| Title | District Health Board linked to a NZ Healthcare Service, Location or Patient |
| Realm | us |
| Authority | hl7 |
| Description | District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address). |
| Purpose | Administrative - to allow NZ HealthcareService, Location (Facility) or Patient Resources to include the related District Health Board. |
| Copyright | HL7 New Zealand© 2020+; Licensed Under Creative Commons No Rights Reserved. |
| Type | Extension |
| Kind | complex-type |
| StructureDefinition | |
| NzHealthcareService | HealthcareService resource for use in NZ |
| NzLocation | Location resource for use in NZ |
| NzPatient | NZ Patient |
| ValueSet | |
| dhb-code | District Health Board Identifer |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition dhb
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..* | Extension | District Health Board linked to a NZ Healthcare Service, Location or Patient | |
  extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/dhb" | |
  value[x] | 0..1 | CodeableConcept | NZ District Health Boards Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs Example Waikato DHB: {"coding":[{"system":"https://standards.digital.health.nz/ns/dhb-code","version":"1.0","code":"G00027-C","display":"Waikato District Health Board"}]} | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "dhb",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3
}
],
"url": "http://hl7.org.nz/fhir/StructureDefinition/dhb",
"version": "1.0",
"name": "Dhb",
"title": "District Health Board linked to a NZ Healthcare Service, Location or Patient",
"status": "active",
"date": "2020-07-31",
"publisher": "HL7 New Zealand",
"contact": [
{
"name": "HL7 New Zealand",
"telecom": [
{
"system": "email",
"value": "mailto:admin@hl7.org.nz"
}
]
}
],
"description": "District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address).",
"purpose": "Administrative - to allow NZ HealthcareService, Location (Facility) or Patient Resources to include the related District Health Board.",
"copyright": "HL7 New Zealand© 2020+; Licensed Under Creative Commons No Rights Reserved.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "HealthcareService"
},
{
"type": "element",
"expression": "Location"
},
{
"type": "element",
"expression": "Patient"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "District Health Board linked to a NZ Healthcare Service, Location or Patient",
"definition": "District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address).",
"min": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Extension.url",
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org.nz/fhir/StructureDefinition/dhb",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"label": "DHB Code",
"short": "NZ District Health Boards",
"definition": "NZ District Health Boards as defined in the NZ Health Provider Index Listing published by the NZ Ministry of Health each month.",
"requirements": "The NzDHB ValueSet should be used as this provides the correct NZ HPI-ORG ID for each of the 20 District Health Boards.The binding strength is extensible as this is the most suitable option for a Codeable Concept data type.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"example": [
{
"label": "Waikato DHB",
"valueCodeableConcept": {
"coding": [
{
"system": "https://standards.digital.health.nz/ns/dhb-code",
"version": "1.0",
"code": "G00027-C",
"display": "Waikato District Health Board"
}
]
}
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"strength": "extensible",
"description": "NZ HPI-ORG Values for DHBs",
"valueSet": "https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code"
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "District Health Board linked to a NZ Healthcare Service, Location or Patient",
"definition": "District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address)."
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org.nz/fhir/StructureDefinition/dhb"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"label": "DHB Code",
"short": "NZ District Health Boards",
"definition": "NZ District Health Boards as defined in the NZ Health Provider Index Listing published by the NZ Ministry of Health each month.",
"requirements": "The NzDHB ValueSet should be used as this provides the correct NZ HPI-ORG ID for each of the 20 District Health Boards.The binding strength is extensible as this is the most suitable option for a Codeable Concept data type.",
"type": [
{
"code": "CodeableConcept"
}
],
"example": [
{
"label": "Waikato DHB",
"valueCodeableConcept": {
"coding": [
{
"system": "https://standards.digital.health.nz/ns/dhb-code",
"version": "1.0",
"code": "G00027-C",
"display": "Waikato District Health Board"
}
]
}
}
],
"binding": {
"strength": "extensible",
"description": "NZ HPI-ORG Values for DHBs",
"valueSet": "https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code"
}
}
]
}
}