FHIR New Zealand Patient Summary IG
0.3.0 - ci-build New Zealand flag

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

: NZPS Summary - XML Representation

Draft as of 2024-01-01

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="NZPSSummaryOperation"/>
  <text>
    <status value="generated"/>
    <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>
</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>
</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>
</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>
</div></td></tr></table></div>
  </text>
  <url
       value="https://standards.digital.health.nz/fhir/OperationDefinition/nzps-summary"/>
  <version value="0.3.0"/>
  <name value="NzpsSummary"/>
  <title value="NZPS Summary"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2024-01-01T13:15:56.964-00:00"/>
  <publisher value="Health NZ | Te Whatu Ora"/>
  <contact>
    <name value="Health NZ | Te Whatu Ora"/>
    <telecom>
      <system value="url"/>
      <value value="https://github.com/tewhatuora"/>
    </telecom>
  </contact>
  <description
               value="The NZPS uses the $summary operation to allow clients to query by NHI number and be returned an NZPS compliant FHIR document. 

The $summary operation is invoked by POST'ing a Parameters resource containing the NHI number of the patient to the $summary endpoint.

Request URL:

`POST [base]/Patient/$summary`

Example Parameters body:

` 
[example Parameters resource here]
`

"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="NZ"/>
      <display value="New Zealand"/>
    </coding>
  </jurisdiction>
  <affectsState value="false"/>
  <code value="summary"/>
  <resource value="Patient"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <parameter>
    <name value="identifier"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="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 value="string"/>
    <searchType value="token"/>
  </parameter>
  <parameter>
    <name value="profile"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="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 value="uri"/>
  </parameter>
  <parameter>
    <name value="graph"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Currently the NZPS summary operation does not require or support a graph definition. This parameter is included for future compatibility if needed."/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="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 value="Bundle"/>
  </parameter>
</OperationDefinition>