STU 3 Candidate
This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
StructureDefinition for ActionDefinition
{
"resourceType": "StructureDefinition",
"id": "ActionDefinition",
"meta": {
"lastUpdated": "2016-03-31T08:01:25.570+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ActionDefinition",
"name": "ActionDefinition",
"status": "draft",
"publisher": "HL7 FHIR Standard",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
}
],
"date": "2016-03-31T08:01:25+11:00",
"description": "Base StructureDefinition for ActionDefinition Type",
"fhirVersion": "1.4.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"kind": "datatype",
"abstract": false,
"baseType": "Element",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
"derivation": "specialization",
"snapshot": {
"element": [
{
"path": "ActionDefinition",
"short": "The definition of an action to be performed",
"definition": "The definition of an action to be performed. Some aspects of the definition are specified statically, and some aspects can be specified dynamically by referencing logic defined in a library.",
"min": 0,
"max": "*",
"type": [
{
"code": "Element"
}
]
},
{
"path": "ActionDefinition.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ActionDefinition.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ActionDefinition.actionIdentifier",
"short": "Unique identifier",
"definition": "A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.label",
"short": "User-visible label for the action (e.g. 1. or A.)",
"definition": "A user-visible label for the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.title",
"short": "User-visible title",
"definition": "The title of the action displayed to a user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.description",
"short": "Short description of the action",
"definition": "A short description of the action used to provide a summary to display to the user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.textEquivalent",
"short": "Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system",
"definition": "A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamically.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.concept",
"short": "The meaning of the action or its sub-actions",
"definition": "The concept represented by this action or its sub-actions.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.supportingEvidence",
"short": "Evidence that supports taking the action",
"definition": "The evidence grade and the sources of evidence for this action.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.documentation",
"short": "Supporting documentation for the intended performer of the action",
"definition": "Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.relatedAction",
"short": "Relationship to another action",
"definition": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".",
"min": 0,
"max": "1",
"type": [
{
"code": "Element"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.relatedAction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ActionDefinition.relatedAction.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ActionDefinition.relatedAction.actionIdentifier",
"short": "Identifier of the related action",
"definition": "The unique identifier of the related action.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.relatedAction.relationship",
"short": "before | after",
"definition": "The relationship of this action to the related action.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Defines the types of relationships between actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-relationship-type"
}
}
},
{
"path": "ActionDefinition.relatedAction.offset[x]",
"short": "Time offset for the relationship",
"definition": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Duration"
]
},
{
"code": "Range"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.relatedAction.anchor",
"short": "start | end",
"definition": "An optional indicator for how the relationship is anchored to the related action. For example \"before the start\" or \"before the end\" of the related action.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Defines possible anchors for the relationship between actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-relationship-anchor"
}
}
},
{
"path": "ActionDefinition.participantType",
"short": "patient | practitioner | related-person",
"definition": "The type of participant in the action.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "The type of participant for the action",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-participant-type"
}
}
},
{
"path": "ActionDefinition.type",
"short": "create | update | remove | fire-event",
"definition": "The type of action to perform (create, update, remove).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The type of action to be performed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-type"
}
}
},
{
"path": "ActionDefinition.behavior",
"short": "Defines behaviors such as selection and grouping",
"definition": "A behavior associated with the action. Behaviors define how the action is to be presented and/or executed within the receiving environment.",
"min": 0,
"max": "*",
"type": [
{
"code": "Element"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.behavior.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ActionDefinition.behavior.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ActionDefinition.behavior.type",
"short": "The type of behavior (grouping, precheck, selection, cardinality, etc)",
"definition": "The type of the behavior to be described, such as grouping, visual, or selection behaviors.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The type of behavior to be defined",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-behavior-type"
}
}
},
{
"path": "ActionDefinition.behavior.value",
"short": "Specific behavior (e.g. required, at-most-one, single, etc)",
"definition": "The specific behavior. The code used here is determined by the type of behavior being described. For example, the grouping behavior uses the grouping-behavior-type valueset.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.resource",
"short": "Static portion of the action definition",
"definition": "The resource that is the target of the action (e.g. CommunicationRequest). The resource described here defines any aspects of the action that can be specified statically (i.e. are known at the time of definition).",
"comments": "Note that the resource is optional, and if no resource is specified, a customization with a root (/) path can be used to define the entire resource dynamically.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"isSummary": true
},
{
"path": "ActionDefinition.customization",
"short": "Dynamic aspects of the definition",
"definition": "Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.",
"min": 0,
"max": "*",
"type": [
{
"code": "Element"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.customization.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ActionDefinition.customization.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ActionDefinition.customization.path",
"short": "The path to the element to be set dynamically",
"definition": "The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.customization.expression",
"short": "An expression that provides the dynamic value for the customization",
"definition": "An expression specifying the value of the customized element.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.action",
"short": "A sub-action",
"definition": "Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.",
"min": 0,
"max": "*",
"type": [
{
"code": "ActionDefinition"
}
],
"isSummary": true
}
]
},
"differential": {
"element": [
{
"path": "ActionDefinition",
"short": "The definition of an action to be performed",
"definition": "The definition of an action to be performed. Some aspects of the definition are specified statically, and some aspects can be specified dynamically by referencing logic defined in a library.",
"min": 0,
"max": "*",
"type": [
{
"code": "Element"
}
]
},
{
"path": "ActionDefinition.actionIdentifier",
"short": "Unique identifier",
"definition": "A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.label",
"short": "User-visible label for the action (e.g. 1. or A.)",
"definition": "A user-visible label for the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.title",
"short": "User-visible title",
"definition": "The title of the action displayed to a user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.description",
"short": "Short description of the action",
"definition": "A short description of the action used to provide a summary to display to the user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.textEquivalent",
"short": "Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system",
"definition": "A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamically.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.concept",
"short": "The meaning of the action or its sub-actions",
"definition": "The concept represented by this action or its sub-actions.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.supportingEvidence",
"short": "Evidence that supports taking the action",
"definition": "The evidence grade and the sources of evidence for this action.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.documentation",
"short": "Supporting documentation for the intended performer of the action",
"definition": "Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.relatedAction",
"short": "Relationship to another action",
"definition": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".",
"min": 0,
"max": "1",
"type": [
{
"code": "Element"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.relatedAction.actionIdentifier",
"short": "Identifier of the related action",
"definition": "The unique identifier of the related action.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.relatedAction.relationship",
"short": "before | after",
"definition": "The relationship of this action to the related action.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Defines the types of relationships between actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-relationship-type"
}
}
},
{
"path": "ActionDefinition.relatedAction.offset[x]",
"short": "Time offset for the relationship",
"definition": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Duration"
]
},
{
"code": "Range"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.relatedAction.anchor",
"short": "start | end",
"definition": "An optional indicator for how the relationship is anchored to the related action. For example \"before the start\" or \"before the end\" of the related action.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Defines possible anchors for the relationship between actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-relationship-anchor"
}
}
},
{
"path": "ActionDefinition.participantType",
"short": "patient | practitioner | related-person",
"definition": "The type of participant in the action.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "The type of participant for the action",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-participant-type"
}
}
},
{
"path": "ActionDefinition.type",
"short": "create | update | remove | fire-event",
"definition": "The type of action to perform (create, update, remove).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The type of action to be performed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-type"
}
}
},
{
"path": "ActionDefinition.behavior",
"short": "Defines behaviors such as selection and grouping",
"definition": "A behavior associated with the action. Behaviors define how the action is to be presented and/or executed within the receiving environment.",
"min": 0,
"max": "*",
"type": [
{
"code": "Element"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.behavior.type",
"short": "The type of behavior (grouping, precheck, selection, cardinality, etc)",
"definition": "The type of the behavior to be described, such as grouping, visual, or selection behaviors.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The type of behavior to be defined",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-behavior-type"
}
}
},
{
"path": "ActionDefinition.behavior.value",
"short": "Specific behavior (e.g. required, at-most-one, single, etc)",
"definition": "The specific behavior. The code used here is determined by the type of behavior being described. For example, the grouping behavior uses the grouping-behavior-type valueset.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.resource",
"short": "Static portion of the action definition",
"definition": "The resource that is the target of the action (e.g. CommunicationRequest). The resource described here defines any aspects of the action that can be specified statically (i.e. are known at the time of definition).",
"comments": "Note that the resource is optional, and if no resource is specified, a customization with a root (/) path can be used to define the entire resource dynamically.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"isSummary": true
},
{
"path": "ActionDefinition.customization",
"short": "Dynamic aspects of the definition",
"definition": "Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.",
"min": 0,
"max": "*",
"type": [
{
"code": "Element"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.customization.path",
"short": "The path to the element to be set dynamically",
"definition": "The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.customization.expression",
"short": "An expression that provides the dynamic value for the customization",
"definition": "An expression specifying the value of the customized element.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ActionDefinition.action",
"short": "A sub-action",
"definition": "Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.",
"min": 0,
"max": "*",
"type": [
{
"code": "ActionDefinition"
}
],
"isSummary": true
}
]
}
}
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.
© HL7.org 2011+. FHIR STU3 Candidate (v1.4.0-8139) generated on Thu, Mar 31, 2016 08:07+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change