minimal Common Oncology Data Elements (mCODE) Implementation Guide, published by HL7 International / Clinical Interoperability Council. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-mCODE-ig/ and changes regularly. See the Directory of published versions
Draft as of 2024-10-30 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="mcode-patient-everything"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition mcode-patient-everything</b></p><a name="mcode-patient-everything"> </a><a name="hcmcode-patient-everything"> </a><a name="mcode-patient-everything-en-US"> </a><p>URL: [base]/Patient/[id]/$mcode-everything</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>id</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Patient ID</p>
</div></td></tr><tr><td>IN</td><td>start</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#date">date</a></td><td/><td><div><p>The date range relates to filtering by date for a subset of resources in the Bundle. If no start date is provided, all records prior to the end date are in scope. Filtering is inclusive (i.e., if <code>start=2020-01-01</code>, records from January 1, 2020 are in scope).</p>
</div></td></tr><tr><td>IN</td><td>end</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#date">date</a></td><td/><td><div><p>The date range relates to filtering by date for a subset of resources in the Bundle. If no end date is provided, all records subsequent to the start date are in scope. Filtering is inclusive (i.e., if <code>end=2020-09-01</code>, records from September 1, 2020 are in scope).</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>A Bundle conforming to <a href="StructureDefinition-mcode-patient-bundle.html"><code>MCODEPatientBundle</code></a>.</p>
</div></td></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="cic"/>
</extension>
<url
value="http://hl7.org/fhir/us/mcode/OperationDefinition/mcode-patient-everything"/>
<version value="4.0.0-ballot"/>
<name value="Fetch_mCODE_patient_bundle"/>
<title value="Fetch mCODE Patient Bundle for a given Patient"/>
<status value="draft"/>
<kind value="operation"/>
<date value="2024-10-30T15:45:56+00:00"/>
<publisher value="HL7 International / Clinical Interoperability Council"/>
<contact>
<name value="HL7 International / Clinical Interoperability Council"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/cic"/>
</telecom>
<telecom>
<system value="email"/>
<value value="ciclist@lists.HL7.org"/>
</telecom>
</contact>
<description
value="Gets an [mCODE Patient Bundle](StructureDefinition-mcode-patient-bundle.html) for a specific patient that contains all of that patient's resources that conform to mCODE Profiles."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<code value="mcode-everything"/>
<resource value="Patient"/>
<system value="false"/>
<type value="false"/>
<instance value="true"/>
<parameter>
<name value="id"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="Patient ID"/>
<type value="string"/>
</parameter>
<parameter>
<name value="start"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The date range relates to filtering by date for a subset of resources in the Bundle. If no start date is provided, all records prior to the end date are in scope. Filtering is inclusive (i.e., if `start=2020-01-01`, records from January 1, 2020 are in scope)."/>
<type value="date"/>
</parameter>
<parameter>
<name value="end"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The date range relates to filtering by date for a subset of resources in the Bundle. If no end date is provided, all records subsequent to the start date are in scope. Filtering is inclusive (i.e., if `end=2020-09-01`, records from September 1, 2020 are in scope)."/>
<type value="date"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="A Bundle conforming to [`MCODEPatientBundle`](StructureDefinition-mcode-patient-bundle.html)."/>
<type value="Bundle"/>
</parameter>
</OperationDefinition>