NZ Shared Digital Health Record API
1.0.2 - release

NZ Shared Digital Health Record API - Local Development build (v1.0.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: SDHR Participation Reason Codes - TTL Representation

Draft as of 2026-06-30

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<http://hl7.org/fhir/CodeSystem/sdhr-participation-reason> a fhir:CodeSystem ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:Resource.id [ fhir:value "sdhr-participation-reason"] ;
  fhir:Resource.meta [
     fhir:Meta.versionId [ fhir:value "1" ]
  ] ;
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ] ;
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem sdhr-participation-reason</b></p><a name=\"sdhr-participation-reason\"> </a><a name=\"hcsdhr-participation-reason\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">version: 1</p></div><p>This  code system <code>https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-participation-reason</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">sdhr-record-withheld<a name=\"sdhr-participation-reason-sdhr-record-withheld\"> </a></td><td>Record withheld</td><td>Record withheld from the service for privacy or confidentiality reasons.</td></tr><tr><td style=\"white-space:nowrap\">sdhr-record-released<a name=\"sdhr-participation-reason-sdhr-record-released\"> </a></td><td>Record released</td><td>Record that was previously withheld has been released (is no longer confidential or restricted) to the service by the patient.</td></tr><tr><td style=\"white-space:nowrap\">sdhr-facility-opt-out<a name=\"sdhr-participation-reason-sdhr-facility-opt-out\"> </a></td><td>Facility opt out</td><td>Patient has opted out of participation entirely at the facility. This means that no records will be shared from that facility.</td></tr><tr><td style=\"white-space:nowrap\">sdhr-facility-opt-in<a name=\"sdhr-participation-reason-sdhr-facility-opt-in\"> </a></td><td>Facility opt in</td><td>Patient has opted in to participation at the facility. This means that records will be shared from that facility.</td></tr><tr><td style=\"white-space:nowrap\">sdhr-hnz-opt-out<a name=\"sdhr-participation-reason-sdhr-hnz-opt-out\"> </a></td><td>HNZ opt out</td><td>Patient has opted out of participation entirely with Health NZ. This means that no records will be shared from any facility.</td></tr><tr><td style=\"white-space:nowrap\">sdhr-hnz-opt-in<a name=\"sdhr-participation-reason-sdhr-hnz-opt-in\"> </a></td><td>HNZ opt in</td><td>Patient has opted in to participation with Health NZ. This means that records will be shared from all facilities.</td></tr></table></div>"
  ] ;
  fhir:CodeSystem.url [ fhir:value "https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-participation-reason"] ;
  fhir:CodeSystem.version [ fhir:value "1.0.2"] ;
  fhir:CodeSystem.name [ fhir:value "SDHRParticipationReason"] ;
  fhir:CodeSystem.title [ fhir:value "SDHR Participation Reason Codes"] ;
  fhir:CodeSystem.status [ fhir:value "draft"] ;
  fhir:CodeSystem.experimental [ fhir:value "false"^^xsd:boolean] ;
  fhir:CodeSystem.date [ fhir:value "2026-06-30T04:46:48+00:00"^^xsd:dateTime] ;
  fhir:CodeSystem.publisher [ fhir:value "Health New Zealand"] ;
  fhir:CodeSystem.contact [
     fhir:index 0 ;
     fhir:ContactDetail.name [ fhir:value "Health New Zealand" ] ;
     fhir:ContactDetail.telecom [
       fhir:index 0 ;
       fhir:ContactPoint.system [ fhir:value "url" ] ;
       fhir:ContactPoint.value [ fhir:value "https://github.com/tewhatuora" ]
     ]
  ], [
     fhir:index 1 ;
     fhir:ContactDetail.name [ fhir:value "HNZ Integration Team" ] ;
     fhir:ContactDetail.telecom [
       fhir:index 0 ;
       fhir:ContactPoint.system [ fhir:value "email" ] ;
       fhir:ContactPoint.value [ fhir:value "integration@tewhatuora.govt.nz" ] ;
       fhir:ContactPoint.use [ fhir:value "work" ]
     ]
  ] ;
  fhir:CodeSystem.description [ fhir:value "This code system defines the reasons for a patient to participate in the Shared Digital Health Record service."] ;
  fhir:CodeSystem.content [ fhir:value "complete"] ;
  fhir:CodeSystem.count [ fhir:value "6"^^xsd:nonNegativeInteger] ;
  fhir:CodeSystem.concept [
     fhir:index 0 ;
     fhir:CodeSystem.concept.code [ fhir:value "sdhr-record-withheld" ] ;
     fhir:CodeSystem.concept.display [ fhir:value "Record withheld" ] ;
     fhir:CodeSystem.concept.definition [ fhir:value "Record withheld from the service for privacy or confidentiality reasons." ]
  ], [
     fhir:index 1 ;
     fhir:CodeSystem.concept.code [ fhir:value "sdhr-record-released" ] ;
     fhir:CodeSystem.concept.display [ fhir:value "Record released" ] ;
     fhir:CodeSystem.concept.definition [ fhir:value "Record that was previously withheld has been released (is no longer confidential or restricted) to the service by the patient." ]
  ], [
     fhir:index 2 ;
     fhir:CodeSystem.concept.code [ fhir:value "sdhr-facility-opt-out" ] ;
     fhir:CodeSystem.concept.display [ fhir:value "Facility opt out" ] ;
     fhir:CodeSystem.concept.definition [ fhir:value "Patient has opted out of participation entirely at the facility. This means that no records will be shared from that facility." ]
  ], [
     fhir:index 3 ;
     fhir:CodeSystem.concept.code [ fhir:value "sdhr-facility-opt-in" ] ;
     fhir:CodeSystem.concept.display [ fhir:value "Facility opt in" ] ;
     fhir:CodeSystem.concept.definition [ fhir:value "Patient has opted in to participation at the facility. This means that records will be shared from that facility." ]
  ], [
     fhir:index 4 ;
     fhir:CodeSystem.concept.code [ fhir:value "sdhr-hnz-opt-out" ] ;
     fhir:CodeSystem.concept.display [ fhir:value "HNZ opt out" ] ;
     fhir:CodeSystem.concept.definition [ fhir:value "Patient has opted out of participation entirely with Health NZ. This means that no records will be shared from any facility." ]
  ], [
     fhir:index 5 ;
     fhir:CodeSystem.concept.code [ fhir:value "sdhr-hnz-opt-in" ] ;
     fhir:CodeSystem.concept.display [ fhir:value "HNZ opt in" ] ;
     fhir:CodeSystem.concept.definition [ fhir:value "Patient has opted in to participation with Health NZ. This means that records will be shared from all facilities." ]
  ] .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/CodeSystem/sdhr-participation-reason.ttl> a owl:Ontology ;
  owl:imports fhir:fhir.ttl ;
  owl:versionIRI <http://build.fhir.org/CodeSystem/sdhr-participation-reason.ttl> .