Conformance
This
page
is
part
of
the
Snapshot
#3
for
FHIR
Specification
(v4.3.0:
R4B
-
STU
).
The
current
version
which
supercedes
this
version
is
5.0.0
R5
,
released
to
support
Connectathon
32
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
| Clinical Decision Support Work Group | Maturity Level : N/A | Standards Status : Informative |
Raw Turtle (+ also see Turtle/RDF Format Specification )
Operation Definition
@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
# - resource -------------------------------------------------------------------
[] a fhir:OperationDefinition;
fhir:Resource.id [ fhir:value "ActivityDefinition-apply"];
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "extensions" ]
];
fhir:DomainResource.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ];
fhir:Extension.value [ fhir:value "3" ]
], [
fhir:index 1;
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ];
fhir:Extension.value [ fhir:value "trial-use" ]
];
fhir:CanonicalResource.url [ fhir:value "http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply"];
fhir:CanonicalResource.version [ fhir:value "5.0.0-snapshot3"];
fhir:CanonicalResource.name [ fhir:value "Apply"];
fhir:CanonicalResource.title [ fhir:value "Apply"];
fhir:CanonicalResource.status [ fhir:value "draft"];
fhir:CanonicalResource.experimental [ fhir:value "false"];
fhir:CanonicalResource.date [ fhir:value "2022-12-14T07:12:54+11:00"];
fhir:CanonicalResource.publisher [ fhir:value "HL7 (FHIR Project)"];
fhir:CanonicalResource.contact [
fhir:ContactDetail.telecom [
fhir:ContactPoint.system [ fhir:value "url" ];
fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
], [
fhir:ContactPoint.system [ fhir:value "email" ];
fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ]
]
];
fhir:CanonicalResource.description [ fhir:value "The apply operation applies a definition in a specific context"];
fhir:CanonicalResource.jurisdiction [
fhir:CodeableConcept.coding [
fhir:Coding.system [ fhir:value "http://unstats.un.org/unsd/methods/m49/m49.htm" ];
fhir:Coding.code [ fhir:value "001" ];
fhir:Coding.display [ fhir:value "World" ]
]
];
fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply"];
fhir:OperationDefinition.version [ fhir:value "4.3.0"];
fhir:OperationDefinition.version [ fhir:value "5.0.0-snapshot3"];
fhir:OperationDefinition.name [ fhir:value "Apply"];
fhir:OperationDefinition.title [ fhir:value "Apply"];
fhir:OperationDefinition.status [ fhir:value "draft"];
fhir:OperationDefinition.kind [ fhir:value "operation"];
fhir:OperationDefinition.experimental [ fhir:value "false"];
fhir:OperationDefinition.date [ fhir:value "2022-05-28T12:47:40+10:00"];
fhir:OperationDefinition.date [ fhir:value "2022-12-14T07:12:54+11:00"];
fhir:OperationDefinition.publisher [ fhir:value "HL7 (FHIR Project)"];
fhir:OperationDefinition.contact [
fhir:index 0;
fhir:ContactDetail.telecom [
fhir:index 0;
fhir:ContactPoint.system [ fhir:value "url" ];
fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
], [
fhir:index 1;
fhir:ContactPoint.system [ fhir:value "email" ];
fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ]
]
];
fhir:OperationDefinition.description [ fhir:value "The apply operation applies a definition in a specific context"];
fhir:OperationDefinition.jurisdiction [
fhir:CodeableConcept.coding [
fhir:Coding.system [ fhir:value "http://unstats.un.org/unsd/methods/m49/m49.htm" ];
fhir:Coding.code [ fhir:value "001" ];
fhir:Coding.display [ fhir:value "World" ]
]
];
fhir:OperationDefinition.affectsState [ fhir:value "false"];
fhir:OperationDefinition.code [ fhir:value "apply"];
fhir:OperationDefinition.comment [ fhir:value "The result of invoking this operation is a resource of the type specified by the activity definition, with all the definitions resolved as appropriate for the type of resource. Any dynamicValue elements will be evaluated (in the order in which they appear in the resource) and the results applied to the returned resource. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation. In addition, parameters to the $apply operation are available within dynamicValue expressions as context variables, accessible by the name of the parameter, prefixed with a percent (%) symbol. For a more detailed description, refer to the ActivityDefinition resource"];
fhir:OperationDefinition.resource [
fhir:value "ActivityDefinition";
fhir:index 0
];
fhir:OperationDefinition.comment [ fhir:value "The result of invoking this operation is a resource of the type specified by the activity definition, with all the definitions resolved as appropriate for the type of resource. Any dynamicValue elements will be evaluated (in the order in which they appear in the resource) and the results applied to the returned resource. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation. In addition, parameters to the $apply operation are available within dynamicValue expressions as context variables, accessible by the name of the parameter, prefixed with a percent (%) symbol. For a more detailed description, refer to the ActivityDefinition resource. Note that result of this operation is transient (i.e. none of the resources created by the operation are persisted in the server, they are all returned as contained resources in the result). The result effectively represents a proposed set of activities, and it is up to the caller to determine whether and how those activities are actually carried out."];
fhir:OperationDefinition.resource [ fhir:value "ActivityDefinition"];
fhir:OperationDefinition.system [ fhir:value "false"];
fhir:OperationDefinition.type [ fhir:value "true"];
fhir:OperationDefinition.instance [ fhir:value "true"];
fhir:OperationDefinition.parameter [
fhir:index 0;
fhir:OperationDefinition.name [ fhir:value "activityDefinition" ];
fhir:OperationDefinition.use [ fhir:value "in" ];
fhir:OperationDefinition.min [ fhir:value "0" ];
fhir:OperationDefinition.max [ fhir:value "1" ];
fhir:OperationDefinition.documentation [ fhir:value "The activity definition to apply. If the operation is invoked on an instance, this parameter is not allowed. If the operation is invoked at the type level, this parameter is required" ];
fhir:OperationDefinition.type [ fhir:value "ActivityDefinition" ]
fhir:OperationDefinitionParameterComponent.name [ fhir:value "activityDefinition" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The activity definition to apply. If the operation is invoked on an instance, this parameter is not allowed. If the operation is invoked at the type level, this parameter is required" ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "ActivityDefinition" ]
], [
fhir:index 1;
fhir:OperationDefinition.name [ fhir:value "subject" ];
fhir:OperationDefinition.use [ fhir:value "in" ];
fhir:OperationDefinition.min [ fhir:value "1" ];
fhir:OperationDefinition.max [ fhir:value "*" ];
fhir:OperationDefinition.documentation [ fhir:value "The subject(s) that is/are the target of the activity definition to be applied. The subject may be a Patient, Practitioner, Organization, Location, Device, or Group. Subjects provided in this parameter will be resolved as the subject of the PlanDefinition based on the type of the subject. If multiple subjects of the same type are provided, the behavior is implementation-defined" ];
fhir:OperationDefinition.type [ fhir:value "string" ];
fhir:OperationDefinition.searchType [ fhir:value "reference" ]
fhir:OperationDefinitionParameterComponent.name [ fhir:value "subject" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "*" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The subject(s) that is/are the target of the activity definition to be applied. The subject may be a Patient, Practitioner, Organization, Location, Device, or Group. Subjects provided in this parameter will be resolved as the subject of the PlanDefinition based on the type of the subject. If multiple subjects of the same type are provided, the behavior is implementation-defined" ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "string" ];
fhir:OperationDefinitionParameterComponent.searchType [ fhir:value "reference" ]
], [
fhir:index 2;
fhir:OperationDefinition.name [ fhir:value "encounter" ];
fhir:OperationDefinition.use [ fhir:value "in" ];
fhir:OperationDefinition.min [ fhir:value "0" ];
fhir:OperationDefinition.max [ fhir:value "1" ];
fhir:OperationDefinition.documentation [ fhir:value "The encounter in context, if any" ];
fhir:OperationDefinition.type [ fhir:value "string" ];
fhir:OperationDefinition.searchType [ fhir:value "reference" ]
fhir:OperationDefinitionParameterComponent.name [ fhir:value "encounter" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The encounter in context, if any" ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "string" ];
fhir:OperationDefinitionParameterComponent.searchType [ fhir:value "reference" ]
], [
fhir:index 3;
fhir:OperationDefinition.name [ fhir:value "practitioner" ];
fhir:OperationDefinition.use [ fhir:value "in" ];
fhir:OperationDefinition.min [ fhir:value "0" ];
fhir:OperationDefinition.max [ fhir:value "1" ];
fhir:OperationDefinition.documentation [ fhir:value "The practitioner in context" ];
fhir:OperationDefinition.type [ fhir:value "string" ];
fhir:OperationDefinition.searchType [ fhir:value "reference" ]
fhir:OperationDefinitionParameterComponent.name [ fhir:value "practitioner" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The practitioner in context" ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "string" ];
fhir:OperationDefinitionParameterComponent.searchType [ fhir:value "reference" ]
], [
fhir:index 4;
fhir:OperationDefinition.name [ fhir:value "organization" ];
fhir:OperationDefinition.use [ fhir:value "in" ];
fhir:OperationDefinition.min [ fhir:value "0" ];
fhir:OperationDefinition.max [ fhir:value "1" ];
fhir:OperationDefinition.documentation [ fhir:value "The organization in context" ];
fhir:OperationDefinition.type [ fhir:value "string" ];
fhir:OperationDefinition.searchType [ fhir:value "reference" ]
fhir:OperationDefinitionParameterComponent.name [ fhir:value "organization" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The organization in context" ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "string" ];
fhir:OperationDefinitionParameterComponent.searchType [ fhir:value "reference" ]
], [
fhir:index 5;
fhir:OperationDefinition.name [ fhir:value "userType" ];
fhir:OperationDefinition.use [ fhir:value "in" ];
fhir:OperationDefinition.min [ fhir:value "0" ];
fhir:OperationDefinition.max [ fhir:value "1" ];
fhir:OperationDefinition.documentation [ fhir:value "The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)" ];
fhir:OperationDefinition.type [ fhir:value "CodeableConcept" ]
fhir:OperationDefinitionParameterComponent.name [ fhir:value "userType" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)" ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "CodeableConcept" ]
], [
fhir:index 6;
fhir:OperationDefinition.name [ fhir:value "userLanguage" ];
fhir:OperationDefinition.use [ fhir:value "in" ];
fhir:OperationDefinition.min [ fhir:value "0" ];
fhir:OperationDefinition.max [ fhir:value "1" ];
fhir:OperationDefinition.documentation [ fhir:value "Preferred language of the person using the system" ];
fhir:OperationDefinition.type [ fhir:value "CodeableConcept" ]
fhir:OperationDefinitionParameterComponent.name [ fhir:value "userLanguage" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "Preferred language of the person using the system" ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "CodeableConcept" ]
], [
fhir:index 7;
fhir:OperationDefinition.name [ fhir:value "userTaskContext" ];
fhir:OperationDefinition.use [ fhir:value "in" ];
fhir:OperationDefinition.min [ fhir:value "0" ];
fhir:OperationDefinition.max [ fhir:value "1" ];
fhir:OperationDefinition.documentation [ fhir:value "The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources" ];
fhir:OperationDefinition.type [ fhir:value "CodeableConcept" ]
fhir:OperationDefinitionParameterComponent.name [ fhir:value "userTaskContext" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources" ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "CodeableConcept" ]
], [
fhir:index 8;
fhir:OperationDefinition.name [ fhir:value "setting" ];
fhir:OperationDefinition.use [ fhir:value "in" ];
fhir:OperationDefinition.min [ fhir:value "0" ];
fhir:OperationDefinition.max [ fhir:value "1" ];
fhir:OperationDefinition.documentation [ fhir:value "The current setting of the request (inpatient, outpatient, etc.)" ];
fhir:OperationDefinition.type [ fhir:value "CodeableConcept" ]
fhir:OperationDefinitionParameterComponent.name [ fhir:value "setting" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The current setting of the request (inpatient, outpatient, etc.)" ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "CodeableConcept" ]
], [
fhir:index 9;
fhir:OperationDefinition.name [ fhir:value "settingContext" ];
fhir:OperationDefinition.use [ fhir:value "in" ];
fhir:OperationDefinition.min [ fhir:value "0" ];
fhir:OperationDefinition.max [ fhir:value "1" ];
fhir:OperationDefinition.documentation [ fhir:value "Additional detail about the setting of the request, if any" ];
fhir:OperationDefinition.type [ fhir:value "CodeableConcept" ]
fhir:OperationDefinitionParameterComponent.name [ fhir:value "settingContext" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "Additional detail about the setting of the request, if any" ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "CodeableConcept" ]
], [
fhir:index 10;
fhir:OperationDefinition.name [ fhir:value "return" ];
fhir:OperationDefinition.use [ fhir:value "out" ];
fhir:OperationDefinition.min [ fhir:value "1" ];
fhir:OperationDefinition.max [ fhir:value "1" ];
fhir:OperationDefinition.documentation [ fhir:value "The resource that is the result of applying the definition" ];
fhir:OperationDefinition.type [ fhir:value "Any" ]
fhir:OperationDefinitionParameterComponent.name [ fhir:value "return" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "out" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The resource that is the result of applying the definition" ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "Resource" ]
] .
# -------------------------------------------------------------------------------------
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
Release
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
Ballot
hl7.fhir.core#5.0.0-snapshot3
generated
on
Sat,
May
28,
Wed,
Dec
14,
2022
12:53+1000.
07:15+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change