This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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
FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
OperationDefinition example
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource ------------------------------------------------------------------- <http://hl7.org/fhir/OperationDefinition/example> a fhir:OperationDefinition; fhir:nodeRole fhir:treeRoot; fhir:Resource.id [ fhir:value "example"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ]; fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>url</b>: <a>http://h7.org/fhir/OperationDefinition/example</a></p><p><b>version</b>: B</p><p><b>name</b>: Populate Questionnaire</p><p><b>status</b>: draft</p><p><b>kind</b>: operation</p><p><b>date</b>: 04/08/2015</p><p><b>publisher</b>: Acme Healthcare Services</p><p><b>contact</b>: </p><p><b>description</b>: Limited implementation of the Populate Questionnaire implemenation</p><p><b>useContext</b>: </p><p><b>jurisdiction</b>: United Kingdom of Great Britain and Northern Ireland (the) <span>(Details : {urn:iso:std:iso:3166 code 'GB' = 'United Kingdom of Great Britain and Northern Ireland', given as 'United Kingdom of Great Britain and Northern Ireland (the)'})</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>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 [[[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.</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>" ]; fhir:OperationDefinition.url [ fhir:value "http://h7.org/fhir/OperationDefinition/example"]; fhir:OperationDefinition.version [ fhir:value "B"]; fhir:OperationDefinition.name [ fhir:value "Populate Questionnaire"]; fhir:OperationDefinition.status [ fhir:value "draft"]; fhir:OperationDefinition.kind [ fhir:value "operation"]; fhir:OperationDefinition.date [ fhir:value "2015-08-04"^^xsd:date]; fhir:OperationDefinition.publisher [ fhir:value "Acme Healthcare Services"]; fhir:OperationDefinition.contact [ fhir:index 0; fhir:ContactDetail.name [ fhir:value "System Administrator" ]; fhir:ContactDetail.telecom [ fhir:index 0; fhir:ContactPoint.system [ fhir:value "email" ]; fhir:ContactPoint.value [ fhir:value "beep@coyote.acme.com" ] ] ]; fhir:OperationDefinition.description [ fhir:value "Limited implementation of the Populate Questionnaire implemenation"]; fhir:OperationDefinition.useContext [ fhir:index 0; fhir:UsageContext.code [ fhir:Coding.system [ fhir:value "http://build.fhir.org/codesystem-usage-context-type" ]; fhir:Coding.code [ fhir:value "venue" ]; fhir:Coding.display [ fhir:value "Clinical Venue" ] ]; fhir:UsageContext.valueCodeableConcept [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://hl7.org/fhir/v3/ActCode" ]; fhir:Coding.code [ fhir:value "IMP" ]; fhir:Coding.display [ fhir:value "inpatient encounter" ] ] ] ]; fhir:OperationDefinition.jurisdiction [ fhir:index 0; fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ]; fhir:Coding.code [ fhir:value "GB" ]; fhir:Coding.display [ fhir:value "United Kingdom of Great Britain and Northern Ireland (the)" ] ] ]; fhir:OperationDefinition.code [ fhir:value "populate"]; fhir:OperationDefinition.comment [ fhir:value "Only implemented for Labs and Medications so far"]; fhir:OperationDefinition.base [ fhir:value "OperationDefinition/Questionnaire-populate"; fhir:link <http://hl7.org/fhir/OperationDefinition/Questionnaire-populate> ]; fhir:OperationDefinition.resource [ fhir:value "Questionnaire"; fhir:index 0 ]; fhir:OperationDefinition.system [ fhir:value "false"^^xsd:boolean]; fhir:OperationDefinition.type [ fhir:value "false"^^xsd:boolean]; fhir:OperationDefinition.instance [ fhir:value "true"^^xsd:boolean]; fhir:OperationDefinition.parameter [ fhir:index 0; fhir:OperationDefinition.parameter.name [ fhir:value "subject" ]; fhir:OperationDefinition.parameter.use [ fhir:value "in" ]; fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ]; fhir:OperationDefinition.parameter.max [ fhir:value "1" ]; fhir:OperationDefinition.parameter.documentation [ fhir: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." ]; fhir:OperationDefinition.parameter.type [ fhir:value "Reference" ] ], [ fhir:index 1; fhir:OperationDefinition.parameter.name [ fhir:value "local" ]; fhir:OperationDefinition.parameter.use [ fhir:value "in" ]; fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ]; fhir:OperationDefinition.parameter.max [ fhir:value "1" ]; fhir:OperationDefinition.parameter.documentation [ fhir:value "If the *local* parameter is set to true, server information about the specified subject will be used to populate the instance." ]; fhir:OperationDefinition.parameter.type [ fhir:value "Reference" ] ], [ fhir:index 2; fhir:OperationDefinition.parameter.name [ fhir:value "return" ]; fhir:OperationDefinition.parameter.use [ fhir:value "out" ]; fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ]; fhir:OperationDefinition.parameter.max [ fhir:value "1" ]; fhir:OperationDefinition.parameter.documentation [ fhir:value "The partially (or fully)-populated set of answers for the specified Questionnaire" ]; fhir:OperationDefinition.parameter.type [ fhir:value "QuestionnaireResponse" ] ]; fhir:OperationDefinition.overload [ fhir:index 0; fhir:OperationDefinition.overload.parameterName [ fhir:value "subject"; fhir:index 0 ], [ fhir:value "local"; fhir:index 1 ] ], [ fhir:index 1; fhir:OperationDefinition.overload.parameterName [ fhir:value "subject"; fhir:index 0 ]; fhir:OperationDefinition.overload.comment [ fhir:value "local defaults to false when not passed as a parameter" ] ] . # - ontology header ------------------------------------------------------------ <http://hl7.org/fhir/OperationDefinition/example.ttl> a owl:Ontology; owl:imports fhir:fhir.ttl; owl:versionIRI <http://build.fhir.org/OperationDefinition/example.ttl> . # -------------------------------------------------------------------------------------
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.