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
| Active as of 2025-07-25 |
{
"resourceType" : "CodeSystem",
"id" : "sdhr-outcome-codes",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem sdhr-outcome-codes</b></p><a name=\"sdhr-outcome-codes\"> </a><a name=\"hcsdhr-outcome-codes\"> </a><p>This case-sensitive code system <code>https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-outcome-codes</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-records-withheld-at-source<a name=\"sdhr-outcome-codes-sdhr-records-withheld-at-source\"> </a></td><td>Records withheld at source</td><td>This code is used when the patient has records that are withheld from the Shared Digital Health Record service at source, for example, a GP practice or hospital.</td></tr><tr><td style=\"white-space:nowrap\">sdhr-participate-deny<a name=\"sdhr-outcome-codes-sdhr-participate-deny\"> </a></td><td>SDHR Participate Deny</td><td>This code is used when the patient has opted out of participating in the Shared Digital Health Record service.</td></tr><tr><td style=\"white-space:nowrap\">sdhr-invalid-patient<a name=\"sdhr-outcome-codes-sdhr-invalid-patient\"> </a></td><td>SDHR Invalid Patient</td><td>This code is used when the patient parameter is invalid for the Shared Digital Health Record service operation. Please ensure the patient is correctly specified and matches the required NHI Patient URL format.</td></tr><tr><td style=\"white-space:nowrap\">sdhr-required-parameter-missing<a name=\"sdhr-outcome-codes-sdhr-required-parameter-missing\"> </a></td><td>SDHR Required parameter missing</td><td>This code is used when a required parameter is missing in the request, such as the reasonCode parameter.</td></tr><tr><td style=\"white-space:nowrap\">sdhr-parameter-invalid<a name=\"sdhr-outcome-codes-sdhr-parameter-invalid\"> </a></td><td>SDHR parameter invalid</td><td>This code is used when a parameter is invalid in the request.</td></tr><tr><td style=\"white-space:nowrap\">sdhr-participation-status-invalid<a name=\"sdhr-outcome-codes-sdhr-participation-status-invalid\"> </a></td><td>SDHR Participation Status Invalid</td><td/></tr><tr><td style=\"white-space:nowrap\">sdhr-operation-success<a name=\"sdhr-outcome-codes-sdhr-operation-success\"> </a></td><td>SDHR Operation Success</td><td>This code is used when the operation was successful, such as when a patient's participation status was successfully recorded.</td></tr><tr><td style=\"white-space:nowrap\">sdhr-participation-unknown<a name=\"sdhr-outcome-codes-sdhr-participation-unknown\"> </a></td><td>SDHR Participation Unknown</td><td>This code is used when the Shared Digital Health Record service has no record of participation preferences for this patient. Please use the $participate operation to indicate the patient's participation preferences.</td></tr></table></div>"
},
"url" : "https://fhir-ig.digital.health.nz/sdhr/CodeSystem/sdhr-outcome-codes",
"version" : "0.6.0",
"name" : "SDHROutcomeCodes",
"title" : "SDHR Specific Outcome Codes",
"status" : "active",
"experimental" : false,
"date" : "2025-07-25T00:20:56+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" : "This code system defines standard OperationOucome codes used throughout this Implementation Guide for New Zealand Shared Digital Health Records",
"purpose" : "The codes defined in this CodeSystem are used by the Shared Digital Health Record service to indicate the outcome of\noperations.\n\nThese codes will be used in various `OperationOutcome` resources to provide feedback on the outcome of a request.\n\nSee [SDHR Participate Operation](https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipateOperation) for more example information on the use of these codes.\n",
"caseSensitive" : true,
"content" : "complete",
"count" : 8,
"concept" : [
{
"code" : "sdhr-records-withheld-at-source",
"display" : "Records withheld at source",
"definition" : "This code is used when the patient has records that are withheld from the Shared Digital Health Record service at source, for example, a GP practice or hospital."
},
{
"code" : "sdhr-participate-deny",
"display" : "SDHR Participate Deny",
"definition" : "This code is used when the patient has opted out of participating in the Shared Digital Health Record service."
},
{
"code" : "sdhr-invalid-patient",
"display" : "SDHR Invalid Patient",
"definition" : "This code is used when the patient parameter is invalid for the Shared Digital Health Record service operation. Please ensure the patient is correctly specified and matches the required NHI Patient URL format."
},
{
"code" : "sdhr-required-parameter-missing",
"display" : "SDHR Required parameter missing",
"definition" : "This code is used when a required parameter is missing in the request, such as the reasonCode parameter."
},
{
"code" : "sdhr-parameter-invalid",
"display" : "SDHR parameter invalid",
"definition" : "This code is used when a parameter is invalid in the request."
},
{
"code" : "sdhr-participation-status-invalid",
"display" : "SDHR Participation Status Invalid"
},
{
"code" : "sdhr-operation-success",
"display" : "SDHR Operation Success",
"definition" : "This code is used when the operation was successful, such as when a patient's participation status was successfully recorded."
},
{
"code" : "sdhr-participation-unknown",
"display" : "SDHR Participation Unknown",
"definition" : "This code is used when the Shared Digital Health Record service has no record of participation preferences for this patient. Please use the $participate operation to indicate the patient's participation preferences."
}
]
}