Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.0 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.0 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2022-09-20 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="QuestionnaireResponse-extract"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition QuestionnaireResponse-extract</b></p><a name="QuestionnaireResponse-extract"> </a><a name="hcQuestionnaireResponse-extract"> </a><a name="QuestionnaireResponse-extract-en-NZ"> </a><p>URL: [base]/QuestionnaireResponse/$extract</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>QuestionnaireResponse</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a></td><td/><td><div><p>Questionnaire Response content to be extracted</p>
</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 Extract Results</p>
</div></td></tr></table><div><p>The extracted resources might include Observations, MedicationStatements and other standard FHIR resources which can then be shared and manipulated. When invoking the $extract operation, care should be taken that the submitted QuestionnaireResponse is itself valid. If not, the extract operation could fail (with appropriate OperationOutcomes) or, more problematic, might succeed but provide incorrect output.</p>
</div></div>
</text>
<url
value="https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/QuestionnaireResponse-extract"/>
<version value="0.4.0"/>
<name value="CareInTheCommunityQuestionnaireResponseExtract"/>
<title
value="Care In The Community QuestionnaireResponse Extract Operation"/>
<status value="draft"/>
<kind value="operation"/>
<date value="2022-09-20"/>
<publisher value="Te Whatu Ora"/>
<contact>
<name value="Te Whatu Ora"/>
<telecom>
<system value="url"/>
<value value="https://www.tewhatuora.govt.nz/"/>
</telecom>
</contact>
<contact>
<name value="David Grainger"/>
<telecom>
<system value="email"/>
<value value="david.grainger@middleware.co.nz"/>
<use value="work"/>
</telecom>
</contact>
<description
value="The Extract operation takes a completed QuestionnaireResponse and converts it to a FHIR resource or Bundle of resources by using metadata embedded in the Questionnaire the QuestionnaireResponse is based on"/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="NZ"/>
<display value="New Zealand"/>
</coding>
</jurisdiction>
<code value="extract"/>
<comment
value="The extracted resources might include Observations, MedicationStatements and other standard FHIR resources which can then be shared and manipulated. When invoking the $extract operation, care should be taken that the submitted QuestionnaireResponse is itself valid. If not, the extract operation could fail (with appropriate OperationOutcomes) or, more problematic, might succeed but provide incorrect output."/>
<base
value="https://build.fhir.org/ig/HL7/sdc/OperationDefinition-QuestionnaireResponse-extract"/>
<resource value="QuestionnaireResponse"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<parameter>
<name value="QuestionnaireResponse"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="Questionnaire Response content to be extracted"/>
<type value="QuestionnaireResponse"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation value="Bundle of Extract Results"/>
<type value="Bundle"/>
</parameter>
</OperationDefinition>