Canonical Resource Management Infrastructure Implementation Guide
1.0.0 - STU1 International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: Shareable OperationDefinition Example - XML Representation

Draft as of 2015-08-04

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="shareable-example"/>
  <meta>
    <profile
             value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareableoperationdefinition"/>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/Questionnaire/[id]/$populate</p><p>Parameters</p><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>subject</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a></td><td/><td><div><p>The resource that is to be the <em>QuestionnaireResponse.subject</em>. The <a href="http://hl7.org/fhir/R4/questionnaireresponse.html#QuestionnaireResponse">QuestionnaireResponse</a>      instance will reference the provided subject.  In addition, if the <em>local</em> parameter is      set to true, server information about the specified subject will be used to populate the      instance.</p>
</div></td></tr><tr><td>IN</td><td>local</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a></td><td/><td><div><p>If the <em>local</em> parameter is set to true, server information about the specified subject will be used to populate the instance.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a></td><td/><td><div><p>The partially (or fully)-populated set of answers for the specified Questionnaire</p>
</div></td></tr></table><div><p>Only implemented for Labs and Medications so far</p>
</div></div>
  </text>
  <url
       value="http://h7.org/fhir/uv/crmi/OperationDefinition/shareable-example"/>
  <version value="1.0.0"/>
  <name value="ShareableOperationDefinitionExample"/>
  <title value="Shareable OperationDefinition Example"/>
  <status value="draft"/>
  <kind value="operation"/>
  <experimental value="true"/>
  <date value="2015-08-04"/>
  <publisher value="HL7 International / Clinical Decision Support"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/dss"/>
    </telecom>
  </contact>
  <description
               value="Limited implementation of the Populate Questionnaire implementation"/>
  <useContext>
    <code>
      <system
              value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
      <code value="venue"/>
      <display value="Clinical Venue"/>
    </code>
    <valueCodeableConcept>
      <coding>
        <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
        <code value="IMP"/>
        <display value="inpatient encounter"/>
      </coding>
    </valueCodeableConcept>
  </useContext>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <code value="populate"/>
  <comment value="Only implemented for Labs and Medications so far"/>
  <resource value="Questionnaire"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="subject"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The resource that is to be the *QuestionnaireResponse.subject*. The [[[QuestionnaireResponse]]]      instance will reference the provided subject.  In addition, if the *local* parameter is      set to true, server information about the specified subject will be used to populate the      instance."/>
    <type value="Reference"/>
  </parameter>
  <parameter>
    <name value="local"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="If the *local* parameter is set to true, server information about the specified subject will be used to populate the instance."/>
    <type value="Reference"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The partially (or fully)-populated set of answers for the specified Questionnaire"/>
    <type value="QuestionnaireResponse"/>
  </parameter>
  <overload>
    <parameterName value="subject"/>
    <parameterName value="local"/>
  </overload>
  <overload>
    <parameterName value="subject"/>
    <comment value="local defaults to false when not passed as a parameter"/>
  </overload>
</OperationDefinition>