FHIR New Zealand Patient Summary IG
0.3.0 - ci-build
FHIR New Zealand Patient Summary IG
0.3.0 - ci-build
FHIR New Zealand Patient Summary IG, published by Health NZ | Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-nzps/ and changes regularly. See the Directory of published versions
| Draft as of 2024-01-01 |
{
"resourceType" : "OperationDefinition",
"id" : "NZPSSummaryOperation",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition NZPSSummaryOperation</b></p><a name=\"NZPSSummaryOperation\"> </a><a name=\"hcNZPSSummaryOperation\"> </a><a name=\"NZPSSummaryOperation-en-NZ\"> </a><p>URL: [base]/Patient/$summary</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>identifier</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>The NHI number of the patient for whom the summary is being requested. This should be provided with the NHI namespace (e.g. 'https://standards.digital.health.nz/ns/nhi-id|ZZZ0032)</p>\n</div></td></tr><tr><td>IN</td><td>profile</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>The profile for the patient summary being requested. For now, only a single profile is supported - the NZPS Bundle: https://standards.digital.health.nz/fhir/StructureDefinition/nzps-bundle</p>\n</div></td></tr><tr><td>IN</td><td>graph</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>Currently the NZPS summary operation does not require or support a graph definition. This parameter is included for future compatibility if needed.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The Bundle returned is a document conforming to the specified input profile parameter or the NZPS <a href=\"./StructureDefinition-nzps-bundle.html\">Bundle profile</a> (if not otherwise specified)</p>\n</div></td></tr></table></div>"
},
"url" : "https://standards.digital.health.nz/fhir/OperationDefinition/nzps-summary",
"version" : "0.3.0",
"name" : "NzpsSummary",
"title" : "NZPS Summary",
"status" : "draft",
"kind" : "operation",
"date" : "2024-01-01T13:15:56.964-00:00",
"publisher" : "Health NZ | Te Whatu Ora",
"contact" : [
{
"name" : "Health NZ | Te Whatu Ora",
"telecom" : [
{
"system" : "url",
"value" : "https://github.com/tewhatuora"
}
]
}
],
"description" : "The NZPS uses the $summary operation to allow clients to query by NHI number and be returned an NZPS compliant FHIR document. \n\nThe $summary operation is invoked by POST'ing a Parameters resource containing the NHI number of the patient to the $summary endpoint.\n\nRequest URL:\n\n`POST [base]/Patient/$summary`\n\nExample Parameters body:\n\n` \n[example Parameters resource here]\n`\n\n",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "NZ",
"display" : "New Zealand"
}
]
}
],
"affectsState" : false,
"code" : "summary",
"resource" : [
"Patient"
],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [
{
"name" : "identifier",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The NHI number of the patient for whom the summary is being requested. This should be provided with the NHI namespace (e.g. 'https://standards.digital.health.nz/ns/nhi-id|ZZZ0032)",
"type" : "string",
"searchType" : "token"
},
{
"name" : "profile",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The profile for the patient summary being requested. For now, only a single profile is supported - the NZPS Bundle: https://standards.digital.health.nz/fhir/StructureDefinition/nzps-bundle",
"type" : "uri"
},
{
"name" : "graph",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Currently the NZPS summary operation does not require or support a graph definition. This parameter is included for future compatibility if needed.",
"type" : "uri"
},
{
"name" : "return",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "The Bundle returned is a document conforming to the specified input profile parameter or the NZPS [Bundle profile](./StructureDefinition-nzps-bundle.html) (if not otherwise specified)",
"type" : "Bundle"
}
]
}