NZ Shared Digital Health Record API
1.1.0 - release

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

: SDHRVerificationSamplesOperation - TTL Representation

Draft as of 2026-07-22

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/SDHRVerificationSamplesOperation> a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:Resource.id [ fhir:value "SDHRVerificationSamplesOperation"] ;
  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 SDHRVerificationSamplesOperation</b></p><a name=\"SDHRVerificationSamplesOperation\"> </a><a name=\"hcSDHRVerificationSamplesOperation\"> </a><p>URL: [base]/AuditEvent/$verification-samples</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>_count</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>Optional page size. Limits the maximum number of sampled AuditEvent resources returned in the Bundle.</p>\n</div></td></tr><tr><td>IN</td><td>_offset</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>Optional zero-based starting offset. Skips the specified number of matching sampled AuditEvent resources before returning results.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>Bundle of sampled AuditEvent resources requiring verification by the authenticated data viewer application. When paging is used, the Bundle may include paging links such as <code>self</code> and <code>next</code>.</p>\n</div></td></tr></table></div>"
  ] ;
  fhir:OperationDefinition.url [ fhir:value "https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRVerificationSamplesOperation"] ;
  fhir:OperationDefinition.version [ fhir:value "1.1.0"] ;
  fhir:OperationDefinition.name [ fhir:value "VerificationSamples"] ;
  fhir:OperationDefinition.status [ fhir:value "draft"] ;
  fhir:OperationDefinition.kind [ fhir:value "operation"] ;
  fhir:OperationDefinition.date [ fhir:value "2026-07-22T06:20:47+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 "DRAFT OPERATION: This operation returns `AuditEvent` resources that have been sampled for verification and are still outstanding for the data viewer application.\n\nThe operation is invoked on the `AuditEvent` type using `GET /AuditEvent/$verification-samples`.\n\nThe response is a `Bundle` containing sampled `AuditEvent` resources that:\n- are pending verification\n- are eligible for the authenticated caller\n- have not already been marked as verified by the data viewer application\n\nThe operation supports optional paging parameters:\n- `_count` to limit the maximum number of samples returned in a single response\n- `_offset` to skip a number of matching samples before returning results"] ;
  fhir:OperationDefinition.code [ fhir:value "verification-samples"] ;
  fhir:OperationDefinition.resource [
     fhir:value "AuditEvent" ;
     fhir:index 0
  ] ;
  fhir:OperationDefinition.system [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.type [ fhir:value "true"^^xsd:boolean] ;
  fhir:OperationDefinition.instance [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.parameter [
     fhir:index 0 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "_count" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Optional page size. Limits the maximum number of sampled AuditEvent resources returned in the Bundle." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "integer" ]
  ], [
     fhir:index 1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "_offset" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Optional zero-based starting offset. Skips the specified number of matching sampled AuditEvent resources before returning results." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "integer" ]
  ], [
     fhir:index 2 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "return" ] ;
     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 "Bundle of sampled AuditEvent resources requiring verification by the authenticated data viewer application. When paging is used, the Bundle may include paging links such as `self` and `next`." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "Bundle" ]
  ] .

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

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