This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
Raw XML (canonical form + also see XML Format Specification)
OperationDefinition example (id = "example")
<?xml version="1.0" encoding="UTF-8"?> <OperationDefinition xmlns="http://hl7.org/fhir"> <id value="example"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative: OperationDefinition</b> <a name="example"> </a> </p> <div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource OperationDefinition "example" </p> </div> <p> <b> url</b> : <code> http://hl7.org/fhir/OperationDefinition/example</code> </p> <p> <b> version</b> : B</p> <p> <b> name</b> : PopulateQuestionnaire</p> <p> <b> title</b> : Populate Questionnaire</p> <p> <b> status</b> : draft</p> <p> <b> kind</b> : operation</p> <p> <b> date</b> : 2015-08-04</p> <p> <b> publisher</b> : Acme Healthcare Services</p> <p> <b> contact</b> : System Administrator: <a href="mailto:beep@coyote.acme.com">beep@coyote.acme.com</a> </p> <p> <b> description</b> : Limited implementation of the Populate Questionnaire implementation</p> <h3> UseContexts</h3> <table class="grid"><tr> <td> -</td> <td> <b> Code</b> </td> <td> <b> Value[x]</b> </td> </tr> <tr> <td> *</td> <td> Clinical Venue (Details: http://terminology.hl7.org/CodeSystem/usage-context-type code venue = 'Clinical Venue', stated as 'Clinical Venue')</td> <td> inpatient encounter <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/4.0.0/CodeSystem-v3-ActCode.html">ActCode</a> #IMP)</span> </td> </tr> </table> <p> <b> jurisdiction</b> : United Kingdom of Great Britain and Northern Ireland (the) <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/4.0.0/CodeSystem-ISO3166Part1.html">ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code</a> #GB)</span> </p> <p> <b> code</b> : populate</p> <p> <b> comment</b> : Only implemented for Labs and Medications so far</p> <p> <b> base</b> : <a href="http://hl7.org/fhir/OperationDefinition/Questionnaire-populate">http://hl7.org/fhir/OperationDefinition/Questionnaire-populate</a> </p> <p> <b> resource</b> : Questionnaire</p> <p> <b> system</b> : false</p> <p> <b> type</b> : false</p> <p> <b> instance</b> : true</p> <blockquote> <p> <b> parameter</b> </p> <p> <b> name</b> : subject</p> <p> <b> use</b> : in</p> <p> <b> min</b> : 1</p> <p> <b> max</b> : 1</p> <p> <b> documentation</b> : The resource that is to be the *QuestionnaireResponse.subject*. The [[[QuestionnaireRespons e]]] 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.</p> <p> <b> type</b> : Reference</p> </blockquote> <blockquote> <p> <b> parameter</b> </p> <p> <b> name</b> : local</p> <p> <b> use</b> : in</p> <p> <b> min</b> : 0</p> <p> <b> max</b> : 1</p> <p> <b> documentation</b> : If the *local* parameter is set to true, server information about the specified subject will be used to populate the instance.</p> <p> <b> type</b> : Reference</p> </blockquote> <blockquote> <p> <b> parameter</b> </p> <p> <b> name</b> : return</p> <p> <b> use</b> : out</p> <p> <b> min</b> : 1</p> <p> <b> max</b> : 1</p> <p> <b> documentation</b> : The partially (or fully)-populated set of answers for the specified Questionnaire</p> <p> <b> type</b> : QuestionnaireResponse</p> </blockquote> <blockquote> <p> <b> overload</b> </p> <p> <b> parameterName</b> : subject, local</p> </blockquote> <blockquote> <p> <b> overload</b> </p> <p> <b> parameterName</b> : subject</p> <p> <b> comment</b> : local defaults to false when not passed as a parameter</p> </blockquote> </div> </text> <url value="http://hl7.org/fhir/OperationDefinition/example"/> <version value="B"/> <name value="PopulateQuestionnaire"/> <title value="Populate Questionnaire"/> <status value="draft"/> <kind value="operation"/> <date value="2015-08-04"/> <publisher value="Acme Healthcare Services"/> <contact> <name value="System Administrator"/> <telecom> <system value="email"/> <value value="beep@coyote.acme.com"/> </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="urn:iso:std:iso:3166"/> <code value="GB"/> <display value="United Kingdom of Great Britain and Northern Ireland (the)"/> </coding> </jurisdiction> <code value="populate"/> <comment value="Only implemented for Labs and Medications so far"/> <base value="http://hl7.org/fhir/OperationDefinition/Questionnaire-populate"/> <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>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0-draft-final generated on Wed, Mar 1, 2023 23:07+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change