FHIR IG analytics| Package | tewhatuora.fhir.nz-shared-digital-health-record |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-facility-participation-extension.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/tewhatuora/fhir-sdhr/StructureDefinition-facility-participation-extension.html |
| URL | https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension |
| Version | 1.0.0 |
| Status | active |
| Date | 2025-11-27T01:34:11+00:00 |
| Name | FacilityParticipationExtension |
| Title | Facility Participation |
| Description | Indicates whether the patient has opted out or opted in to participation at the facility. If opted out, no records will be shared from that facility. |
| Type | Extension |
| Kind | complex-type |
| StructureDefinition | |
| SDHRConsent | SDHRConsent |
| ValueSet | |
| sdhr-participation-reason-valueset | ValueSet for SDHR Participation Reason |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition facility-participation-extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..* | Extension | Facility Participation | |
  extension | 0..0 | Extension | ||
| url | 1..1 | uri | "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension" | |
  Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Open by type:$this | |
   value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Use sdhr-facility-opt-out if the patient has opted out, sdhr-facility-opt-in if the patient has opted in Binding: ValueSet for SDHR Participation Reason (required) | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "facility-participation-extension",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension",
"version": "1.0.0",
"name": "FacilityParticipationExtension",
"title": "Facility Participation",
"status": "active",
"date": "2025-11-27T01:34:11+00:00",
"publisher": "Health New Zealand",
"contact": [
{
"name": "Health New Zealand",
"telecom": [
{
"system": "url",
"value": "https://github.com/tewhatuora"
}
]
},
{
"name": "HNZ Integration Team",
"telecom": [
{
"system": "email",
"value": "integration@tewhatuora.govt.nz",
"use": "work"
}
]
}
],
"description": "Indicates whether the patient has opted out or opted in to participation at the facility. If opted out, no records will be shared from that facility.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Element"
}
],
"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": "Facility Participation",
"definition": "Indicates whether the patient has opted out or opted in to participation at the facility. If opted out, no records will be shared from that facility.",
"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": "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "closed"
},
"short": "Value of extension",
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"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,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]:valueCodeableConcept",
"path": "Extension.value[x]",
"sliceName": "valueCodeableConcept",
"short": "Use sdhr-facility-opt-out if the patient has opted out, sdhr-facility-opt-in if the patient has opted in",
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"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": "required",
"valueSet": "https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-participation-reason-valueset"
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Facility Participation",
"definition": "Indicates whether the patient has opted out or opted in to participation at the facility. If opted out, no records will be shared from that facility."
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "open"
},
"min": 1
},
{
"id": "Extension.value[x]:valueCodeableConcept",
"path": "Extension.value[x]",
"sliceName": "valueCodeableConcept",
"short": "Use sdhr-facility-opt-out if the patient has opted out, sdhr-facility-opt-in if the patient has opted in",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-participation-reason-valueset"
}
}
]
}
}