NZ Shared Digital Health Record API
0.6.0 - ballot
NZ Shared Digital Health Record API
0.6.0 - ballot
NZ Shared Digital Health Record API - Local Development build (v0.6.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension | Version: 0.6.0 | |||
| Draft as of 2025-08-07 | Computable Name: FacilityParticipationExtension | |||
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.
Context of Use
This extension may be used on the following element(s)
Element
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Facility Participation | |
  extension |
0..0 | |||
| 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Facility Participation | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| 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, Closed 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 | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Facility Participation | |
| extension |
0..0 | |||
| 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 | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Facility Participation | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| 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, Closed 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 | ||||
This structure is derived from Extension
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet | URI |
| Extension.value[x]:valueCodeableConcept | required | SDHRParticipationReasonValueSet(a valid code from SDHR Participation Reason Codes)https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-participation-reason-valuesetFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |