NZ Shared Digital Health Record API
1.1.3 - release

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

: SDHRParticipationStatusOperation - TTL Representation

Active as of 2026-08-12

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/OperationDefinition/SDHRParticipationStatusOperation> a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:Resource.id [ fhir:value "SDHRParticipationStatusOperation"] ;
  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: OperationDefinition SDHRParticipationStatusOperation</b></p><a name=\"SDHRParticipationStatusOperation\"> </a><a name=\"hcSDHRParticipationStatusOperation\"> </a><p>URL: [base]/$participation-status</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>patient</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA</p>\n</div></td></tr><tr><td>OUT</td><td>hnzParticipationIndicator</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Indicates whether the patient is currently participating in the Shared Digital Health Record service.</p>\n</div></td></tr></table></div>"
  ] ;
  fhir:OperationDefinition.url [ fhir:value "https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipationStatusOperation"] ;
  fhir:OperationDefinition.version [ fhir:value "1.1.3"] ;
  fhir:OperationDefinition.name [ fhir:value "ParticipationStatus"] ;
  fhir:OperationDefinition.status [ fhir:value "active"] ;
  fhir:OperationDefinition.kind [ fhir:value "operation"] ;
  fhir:OperationDefinition.date [ fhir:value "2026-08-12T03:34:31+00:00"^^xsd:dateTime] ;
  fhir:OperationDefinition.publisher [ fhir:value "Health New Zealand"] ;
  fhir:OperationDefinition.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:OperationDefinition.description [ fhir:value "This operation allows Shared Electronic Health Record (SEHR) systems to retrieve a patient's Shared Digital Health Record participation status.\n\nFor example response payloads for this operation see:\n- [Parameters resource for participation status response - not participating](./Parameters-ParametersParticipationStatusNotParticipatingResponse.html) : This example shows the `Parameters` resource returned when the patient is not participating in the Shared Digital Health Record service.\n- [Parameters resource for participation status response - participating](./Parameters-ParametersParticipationStatusParticipatingResponse.html) : This example shows the `Parameters` resource returned when the patient is participating in the Shared Digital Health Record service.\n\nTo make a request to this operation the API Consumer must POST a `Parameters` payload to the operation URL (e.g. `POST https://api.sdhr.digital.health.nz/s2s/$participation-status`).\n\nThe operation is expected to be called by a healthcare provider on behalf of the patient, and the patient must be identified by their NHI.\nThe operation will return a `Parameters` resource containing the patient reference and participation status indicators."] ;
  fhir:OperationDefinition.code [ fhir:value "participation-status"] ;
  fhir:OperationDefinition.system [ fhir:value "true"^^xsd:boolean] ;
  fhir:OperationDefinition.type [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.instance [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.parameter [
     fhir:index 0 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "patient" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA" ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "Reference" ]
  ], [
     fhir:index 1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "hnzParticipationIndicator" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Indicates whether the patient is currently participating in the Shared Digital Health Record service." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
  ] .

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

<http://hl7.org/fhir/OperationDefinition/SDHRParticipationStatusOperation.ttl> a owl:Ontology ;
  owl:imports fhir:fhir.ttl ;
  owl:versionIRI <http://build.fhir.org/OperationDefinition/SDHRParticipationStatusOperation.ttl> .