This page is part of the FHIR Specification (v5.0.0-snapshot1: Release 5 Snapshot #1). 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 JSON (canonical form + also see JSON Format Specification)
OperationDefinition example
{
"resourceType": "OperationDefinition",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><div><p>Resource "example" </p></div><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>: 2015-08-04</p><p><b>publisher</b>: Acme Healthcare Services</p><p><b>contact</b>: System Administrator: <a>beep@coyote.acme.com</a></p><p><b>description</b>: Limited implementation of the Populate Questionnaire implementation</p><p><b>jurisdiction</b>: United Kingdom of Great Britain and Northern Ireland (the) <span> (unknown#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>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 [[[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>"
},
"url": "http://h7.org/fhir/OperationDefinition/example",
"version": "B",
"name": "Populate Questionnaire",
"status": "draft",
"kind": "operation",
"date": "2015-08-04",
"publisher": "Acme Healthcare Services",
"contact": [
{
"name": "System Administrator",
"telecom": [
{
"system": "email",
"value": "beep@coyote.acme.com"
}
]
}
],
"description": "Limited implementation of the Populate Questionnaire implementation",
"useContext": [
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "venue",
"display": "Clinical Venue"
},
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "IMP",
"display": "inpatient encounter"
}
]
}
}
],
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "GB",
"display": "United Kingdom of Great Britain and Northern Ireland (the)"
}
]
}
],
"code": "populate",
"comment": "Only implemented for Labs and Medications so far",
"base": "http://hl7.org/fhir/OperationDefinition/Questionnaire-populate",
"resource": [
"Questionnaire"
],
"system": false,
"type": false,
"instance": true,
"parameter": [
{
"name": "subject",
"use": "in",
"min": 1,
"max": "1",
"documentation": "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": "Reference"
},
{
"name": "local",
"use": "in",
"min": 0,
"max": "1",
"documentation": "If the *local* parameter is set to true, server information about the specified subject will be used to populate the instance.",
"type": "Reference"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The partially (or fully)-populated set of answers for the specified Questionnaire",
"type": "QuestionnaireResponse"
}
],
"overload": [
{
"parameterName": [
"subject",
"local"
]
},
{
"parameterName": [
"subject"
],
"comment": "local defaults to false when not passed as a parameter"
}
]
}
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.