STU3 Candidate
Clinical ReasoningThis page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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
StructureDefinition for plandefinition
{
"resourceType": "StructureDefinition",
"id": "PlanDefinition",
"meta": {
"lastUpdated": "2016-12-06T12:22:34.981+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cds"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"name": "PlanDefinition",
"status": "draft",
"publisher": "Health Level Seven International (Clinical Decision Support)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/dss/index.cfm"
}
]
}
],
"date": "2016-12-06T12:22:34+11:00",
"description": "Base StructureDefinition for PlanDefinition Resource",
"fhirVersion": "1.8.0",
"mapping": [
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "PlanDefinition",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString": "MetadataResource"
}
]
},
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "PlanDefinition",
"path": "PlanDefinition",
"short": "The definition of a plan for a series of actions, independent of any specific patient or context",
"definition": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"id": "PlanDefinition.id",
"path": "PlanDefinition.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "PlanDefinition.meta",
"path": "PlanDefinition.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "PlanDefinition.implicitRules",
"path": "PlanDefinition.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "PlanDefinition.language",
"path": "PlanDefinition.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "PlanDefinition.text",
"path": "PlanDefinition.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "PlanDefinition.contained",
"path": "PlanDefinition.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PlanDefinition.extension",
"path": "PlanDefinition.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 resource. 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": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PlanDefinition.modifierExtension",
"path": "PlanDefinition.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.",
"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": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PlanDefinition.url",
"path": "PlanDefinition.url",
"short": "Logical uri to reference this plan definition (globally unique)",
"definition": "An absolute URL that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).",
"comments": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.",
"requirements": "Allows the plan definition to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "PlanDefinition.identifier",
"path": "PlanDefinition.identifier",
"short": "Additional identifier for the plan definition",
"definition": "A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comments": "Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this plan definition outside of FHIR, where the logical URL is not possible to use.",
"requirements": "Allows externally provided and/or useable business identifiers to be easily associated with the module.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "PlanDefinition.version",
"path": "PlanDefinition.version",
"short": "Business version of the plan definition",
"definition": "The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.",
"comments": "There may be multiple different instances of a plan definition that have the same identifier but different versions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "PlanDefinition.name",
"path": "PlanDefinition.name",
"short": "Name for this plan definition (Computer friendly)",
"definition": "A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comments": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.",
"requirements": "Support human navigation & code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "PlanDefinition.title",
"path": "PlanDefinition.title",
"short": "Name for this plan definition (Human friendly)",
"definition": "A short, descriptive, user-friendly title for the plan definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "PlanDefinition.type",
"path": "PlanDefinition.type",
"short": "order-set | protocol | eca-rule",
"definition": "The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The type of PlanDefinition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/plan-definition-type"
}
}
},
{
"id": "PlanDefinition.status",
"path": "PlanDefinition.status",
"short": "draft | active | retired",
"definition": "The status of this plan definition. Enables tracking the life-cycle of the content.",
"comments": "Allows filtering of plan definition that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "PlanDefinition.experimental",
"path": "PlanDefinition.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of plan definition that are appropriate for use vs. not.",
"requirements": "Enables experimental content to be developed following the same life-cycle as a production-level plan definition would.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "PlanDefinition.date",
"path": "PlanDefinition.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the plan definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "PlanDefinition.description",
"path": "PlanDefinition.description",
"short": "Natural language description of the plan definition",
"definition": "A free text natural language description of the plan definition from the consumer's perspective.",
"comments": "This description can be used to capture details such as why the plan definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "PlanDefinition.purpose",
"path": "PlanDefinition.purpose",
"short": "Why this plan definition is defined",
"definition": "Explains why this plan definition is needed and why it has been designed as it has.",
"comments": "This element does not describe the usage of the plan definition (See, e.g, the comments element, or relatedArtifacts), rather it's for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "PlanDefinition.usage",
"path": "PlanDefinition.usage",
"short": "Describes the clinical usage of the asset",
"definition": "A detailed description of how the asset is used from a clinical perspective.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.approvalDate",
"path": "PlanDefinition.approvalDate",
"short": "When plan definition approved by publisher",
"definition": "The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comments": "The date may be more recent than the approval date because of minor changes / editorial corrections.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "PlanDefinition.lastReviewDate",
"path": "PlanDefinition.lastReviewDate",
"short": "Last review date for the plan definition",
"definition": "The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.",
"comments": "If specified, this is usually after the approval date.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "PlanDefinition.effectivePeriod",
"path": "PlanDefinition.effectivePeriod",
"short": "The effective date range for the plan definition",
"definition": "The period during which the plan definition content was or is planned to be effective.",
"comments": "The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "PlanDefinition.useContext",
"path": "PlanDefinition.useContext",
"short": "Content intends to support these contexts",
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.",
"comments": "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "PlanDefinition.jurisdiction",
"path": "PlanDefinition.jurisdiction",
"short": "Intended jurisdiction for plan definition (if applicable)",
"definition": "A jurisdiction in which the plan definition is intended to be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "PlanDefinition.topic",
"path": "PlanDefinition.topic",
"short": "Descriptional topics for the asset",
"definition": "Clinical topics related to the content of the asset.",
"requirements": "Repositories must be able to determine how to categorize the asset so that it can be found by topical searches.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "PlanDefinition.contributor",
"path": "PlanDefinition.contributor",
"short": "A content contributor",
"definition": "A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.",
"requirements": "Consumers of the content must be able to quickly determine who contributed to the content of the asset.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contributor"
}
]
},
{
"id": "PlanDefinition.publisher",
"path": "PlanDefinition.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the plan definition.",
"comments": "Usually an organization, but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the plan definition. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "PlanDefinition.contact",
"path": "PlanDefinition.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "PlanDefinition.copyright",
"path": "PlanDefinition.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.",
"requirements": "Consumers of the library must be able to determine any legal restrictions on the use of the plan definition and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "PlanDefinition.relatedArtifact",
"path": "PlanDefinition.relatedArtifact",
"short": "Related artifacts for the asset",
"definition": "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comments": "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements": "Assets must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min": 0,
"max": "*",
"type": [
{
"code": "RelatedArtifact"
}
]
},
{
"id": "PlanDefinition.library",
"path": "PlanDefinition.library",
"short": "Logic used by the plan definition",
"definition": "A reference to a Library resource containing any formal logic used by the plan definition.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Library"
}
]
},
{
"id": "PlanDefinition.actionDefinition",
"path": "PlanDefinition.actionDefinition",
"short": "Action defined by the plan",
"definition": "An action to be taken as part of the plan.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "PlanDefinition.actionDefinition.id",
"path": "PlanDefinition.actionDefinition.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PlanDefinition.actionDefinition.extension",
"path": "PlanDefinition.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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.modifierExtension",
"path": "PlanDefinition.actionDefinition.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PlanDefinition.actionDefinition.actionIdentifier",
"path": "PlanDefinition.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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.label",
"path": "PlanDefinition.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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.title",
"path": "PlanDefinition.actionDefinition.title",
"short": "User-visible title",
"definition": "The title of the action displayed to a user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.description",
"path": "PlanDefinition.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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.textEquivalent",
"path": "PlanDefinition.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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.code",
"path": "PlanDefinition.actionDefinition.code",
"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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.documentation",
"path": "PlanDefinition.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": "RelatedArtifact"
}
]
},
{
"id": "PlanDefinition.actionDefinition.triggerDefinition",
"path": "PlanDefinition.actionDefinition.triggerDefinition",
"short": "When the action should be triggered",
"definition": "A description of when the action should be triggered.",
"min": 0,
"max": "*",
"type": [
{
"code": "TriggerDefinition"
}
]
},
{
"id": "PlanDefinition.actionDefinition.condition",
"path": "PlanDefinition.actionDefinition.condition",
"short": "Whether or not the action is applicable",
"definition": "An expression that describes applicability criteria, or start/stop conditions for the action.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "PlanDefinition.actionDefinition.condition.id",
"path": "PlanDefinition.actionDefinition.condition.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PlanDefinition.actionDefinition.condition.extension",
"path": "PlanDefinition.actionDefinition.condition.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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.condition.modifierExtension",
"path": "PlanDefinition.actionDefinition.condition.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PlanDefinition.actionDefinition.condition.kind",
"path": "PlanDefinition.actionDefinition.condition.kind",
"short": "applicability | start | stop",
"definition": "The kind of condition.",
"comments": "Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe when enter/exit criteria for an action.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines the kinds of conditions that can appear on actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-condition-kind"
}
}
},
{
"id": "PlanDefinition.actionDefinition.condition.description",
"path": "PlanDefinition.actionDefinition.condition.description",
"short": "Natural language description of the condition",
"definition": "A brief, natural language description of the condition that effectively communicates the intended semantics.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.condition.language",
"path": "PlanDefinition.actionDefinition.condition.language",
"short": "Language of the expression",
"definition": "The media type of the language for the expression.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.condition.expression",
"path": "PlanDefinition.actionDefinition.condition.expression",
"short": "Boolean-valued expression",
"definition": "An expression that returns true or false, indicating whether or not the condition is satisfied.",
"comments": "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.input",
"path": "PlanDefinition.actionDefinition.input",
"short": "Input data requirements",
"definition": "Defines input data requirements for the action.",
"min": 0,
"max": "*",
"type": [
{
"code": "DataRequirement"
}
]
},
{
"id": "PlanDefinition.actionDefinition.output",
"path": "PlanDefinition.actionDefinition.output",
"short": "Output data definition",
"definition": "Defines the outputs of the action, if any.",
"min": 0,
"max": "*",
"type": [
{
"code": "DataRequirement"
}
]
},
{
"id": "PlanDefinition.actionDefinition.relatedAction",
"path": "PlanDefinition.actionDefinition.relatedAction",
"short": "Relationship to another action",
"definition": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".",
"comments": "When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "PlanDefinition.actionDefinition.relatedAction.id",
"path": "PlanDefinition.actionDefinition.relatedAction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PlanDefinition.actionDefinition.relatedAction.extension",
"path": "PlanDefinition.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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.relatedAction.modifierExtension",
"path": "PlanDefinition.actionDefinition.relatedAction.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PlanDefinition.actionDefinition.relatedAction.actionIdentifier",
"path": "PlanDefinition.actionDefinition.relatedAction.actionIdentifier",
"short": "Identifier of the related action",
"definition": "The unique identifier of the related action.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "PlanDefinition.actionDefinition.relatedAction.relationship",
"path": "PlanDefinition.actionDefinition.relatedAction.relationship",
"short": "before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end",
"definition": "The relationship of this action to the related action.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines the types of relationships between actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-relationship-type"
}
}
},
{
"id": "PlanDefinition.actionDefinition.relatedAction.offset[x]",
"path": "PlanDefinition.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": "Duration"
},
{
"code": "Range"
}
]
},
{
"id": "PlanDefinition.actionDefinition.timing[x]",
"path": "PlanDefinition.actionDefinition.timing[x]",
"short": "When the action should take place",
"definition": "An optional value describing when the action should be performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Duration"
},
{
"code": "Range"
},
{
"code": "Timing"
}
]
},
{
"id": "PlanDefinition.actionDefinition.participantType",
"path": "PlanDefinition.actionDefinition.participantType",
"short": "patient | practitioner | related-person",
"definition": "The type of participant in the action.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The type of participant for the action",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-participant-type"
}
}
},
{
"id": "PlanDefinition.actionDefinition.type",
"path": "PlanDefinition.actionDefinition.type",
"short": "create | update | remove | fire-event",
"definition": "The type of action to perform (create, update, remove).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "required",
"description": "The type of action to be performed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-type"
}
}
},
{
"id": "PlanDefinition.actionDefinition.groupingBehavior",
"path": "PlanDefinition.actionDefinition.groupingBehavior",
"short": "visual-group | logical-group | sentence-group",
"definition": "Defines the grouping behavior for the action and its children.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines organization behavior of a group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-grouping-behavior"
}
}
},
{
"id": "PlanDefinition.actionDefinition.selectionBehavior",
"path": "PlanDefinition.actionDefinition.selectionBehavior",
"short": "any | all | all-or-none | exactly-one | at-most-one | one-or-more",
"definition": "Defines the selection behavior for the action and its children.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines selection behavior of a group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-selection-behavior"
}
}
},
{
"id": "PlanDefinition.actionDefinition.requiredBehavior",
"path": "PlanDefinition.actionDefinition.requiredBehavior",
"short": "must | could | must-unless-documented",
"definition": "Defines the requiredness behavior for the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines requiredness behavior for selecting an action or an action group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-required-behavior"
}
}
},
{
"id": "PlanDefinition.actionDefinition.precheckBehavior",
"path": "PlanDefinition.actionDefinition.precheckBehavior",
"short": "yes | no",
"definition": "Defines whether the action should usually be preselected.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines selection frequency behavior for an action or group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-precheck-behavior"
}
}
},
{
"id": "PlanDefinition.actionDefinition.cardinalityBehavior",
"path": "PlanDefinition.actionDefinition.cardinalityBehavior",
"short": "single | multiple",
"definition": "Defines whether the action can be selected multiple times.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines behavior for an action or a group for how many times that item may be repeated",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-cardinality-behavior"
}
}
},
{
"id": "PlanDefinition.actionDefinition.activityDefinition",
"path": "PlanDefinition.actionDefinition.activityDefinition",
"short": "Description of the activity to be performed",
"definition": "A reference to an ActivityDefinition that describes the action to be taken in detail.",
"comments": "Note that the resource is optional, and if no resource is specified, a dynamicValue with a root (/) path can be used to define the entire resource dynamically.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
}
]
},
{
"id": "PlanDefinition.actionDefinition.transform",
"path": "PlanDefinition.actionDefinition.transform",
"short": "Transform to apply the template",
"definition": "A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureMap"
}
]
},
{
"id": "PlanDefinition.actionDefinition.dynamicValue",
"path": "PlanDefinition.actionDefinition.dynamicValue",
"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": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "PlanDefinition.actionDefinition.dynamicValue.id",
"path": "PlanDefinition.actionDefinition.dynamicValue.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PlanDefinition.actionDefinition.dynamicValue.extension",
"path": "PlanDefinition.actionDefinition.dynamicValue.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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.dynamicValue.modifierExtension",
"path": "PlanDefinition.actionDefinition.dynamicValue.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PlanDefinition.actionDefinition.dynamicValue.description",
"path": "PlanDefinition.actionDefinition.dynamicValue.description",
"short": "Natural language description of the dynamic value",
"definition": "A brief, natural language description of the intended semantics of the dynamic value.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.dynamicValue.path",
"path": "PlanDefinition.actionDefinition.dynamicValue.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": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.dynamicValue.language",
"path": "PlanDefinition.actionDefinition.dynamicValue.language",
"short": "Language of the expression",
"definition": "The media type of the language for the expression.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.dynamicValue.expression",
"path": "PlanDefinition.actionDefinition.dynamicValue.expression",
"short": "An expression that provides the dynamic value for the customization",
"definition": "An expression specifying the value of the customized element.",
"comments": "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.actionDefinition",
"path": "PlanDefinition.actionDefinition.actionDefinition",
"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": "*",
"contentReference": "#PlanDefinition.actionDefinition"
}
]
},
"differential": {
"element": [
{
"id": "PlanDefinition",
"path": "PlanDefinition",
"short": "The definition of a plan for a series of actions, independent of any specific patient or context",
"definition": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"id": "PlanDefinition.url",
"path": "PlanDefinition.url",
"short": "Logical uri to reference this plan definition (globally unique)",
"definition": "An absolute URL that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).",
"comments": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.",
"requirements": "Allows the plan definition to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "PlanDefinition.identifier",
"path": "PlanDefinition.identifier",
"short": "Additional identifier for the plan definition",
"definition": "A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comments": "Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this plan definition outside of FHIR, where the logical URL is not possible to use.",
"requirements": "Allows externally provided and/or useable business identifiers to be easily associated with the module.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "PlanDefinition.version",
"path": "PlanDefinition.version",
"short": "Business version of the plan definition",
"definition": "The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.",
"comments": "There may be multiple different instances of a plan definition that have the same identifier but different versions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "PlanDefinition.name",
"path": "PlanDefinition.name",
"short": "Name for this plan definition (Computer friendly)",
"definition": "A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comments": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.",
"requirements": "Support human navigation & code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "PlanDefinition.title",
"path": "PlanDefinition.title",
"short": "Name for this plan definition (Human friendly)",
"definition": "A short, descriptive, user-friendly title for the plan definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "PlanDefinition.type",
"path": "PlanDefinition.type",
"short": "order-set | protocol | eca-rule",
"definition": "The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The type of PlanDefinition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/plan-definition-type"
}
}
},
{
"id": "PlanDefinition.status",
"path": "PlanDefinition.status",
"short": "draft | active | retired",
"definition": "The status of this plan definition. Enables tracking the life-cycle of the content.",
"comments": "Allows filtering of plan definition that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "PlanDefinition.experimental",
"path": "PlanDefinition.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of plan definition that are appropriate for use vs. not.",
"requirements": "Enables experimental content to be developed following the same life-cycle as a production-level plan definition would.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "PlanDefinition.date",
"path": "PlanDefinition.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the plan definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "PlanDefinition.description",
"path": "PlanDefinition.description",
"short": "Natural language description of the plan definition",
"definition": "A free text natural language description of the plan definition from the consumer's perspective.",
"comments": "This description can be used to capture details such as why the plan definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "PlanDefinition.purpose",
"path": "PlanDefinition.purpose",
"short": "Why this plan definition is defined",
"definition": "Explains why this plan definition is needed and why it has been designed as it has.",
"comments": "This element does not describe the usage of the plan definition (See, e.g, the comments element, or relatedArtifacts), rather it's for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "PlanDefinition.usage",
"path": "PlanDefinition.usage",
"short": "Describes the clinical usage of the asset",
"definition": "A detailed description of how the asset is used from a clinical perspective.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.approvalDate",
"path": "PlanDefinition.approvalDate",
"short": "When plan definition approved by publisher",
"definition": "The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comments": "The date may be more recent than the approval date because of minor changes / editorial corrections.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "PlanDefinition.lastReviewDate",
"path": "PlanDefinition.lastReviewDate",
"short": "Last review date for the plan definition",
"definition": "The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.",
"comments": "If specified, this is usually after the approval date.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "PlanDefinition.effectivePeriod",
"path": "PlanDefinition.effectivePeriod",
"short": "The effective date range for the plan definition",
"definition": "The period during which the plan definition content was or is planned to be effective.",
"comments": "The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "PlanDefinition.useContext",
"path": "PlanDefinition.useContext",
"short": "Content intends to support these contexts",
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.",
"comments": "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "PlanDefinition.jurisdiction",
"path": "PlanDefinition.jurisdiction",
"short": "Intended jurisdiction for plan definition (if applicable)",
"definition": "A jurisdiction in which the plan definition is intended to be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "PlanDefinition.topic",
"path": "PlanDefinition.topic",
"short": "Descriptional topics for the asset",
"definition": "Clinical topics related to the content of the asset.",
"requirements": "Repositories must be able to determine how to categorize the asset so that it can be found by topical searches.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "PlanDefinition.contributor",
"path": "PlanDefinition.contributor",
"short": "A content contributor",
"definition": "A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.",
"requirements": "Consumers of the content must be able to quickly determine who contributed to the content of the asset.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contributor"
}
]
},
{
"id": "PlanDefinition.publisher",
"path": "PlanDefinition.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the plan definition.",
"comments": "Usually an organization, but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the plan definition. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "PlanDefinition.contact",
"path": "PlanDefinition.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "PlanDefinition.copyright",
"path": "PlanDefinition.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.",
"requirements": "Consumers of the library must be able to determine any legal restrictions on the use of the plan definition and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "PlanDefinition.relatedArtifact",
"path": "PlanDefinition.relatedArtifact",
"short": "Related artifacts for the asset",
"definition": "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comments": "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements": "Assets must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min": 0,
"max": "*",
"type": [
{
"code": "RelatedArtifact"
}
]
},
{
"id": "PlanDefinition.library",
"path": "PlanDefinition.library",
"short": "Logic used by the plan definition",
"definition": "A reference to a Library resource containing any formal logic used by the plan definition.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Library"
}
]
},
{
"id": "PlanDefinition.actionDefinition",
"path": "PlanDefinition.actionDefinition",
"short": "Action defined by the plan",
"definition": "An action to be taken as part of the plan.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "PlanDefinition.actionDefinition.actionIdentifier",
"path": "PlanDefinition.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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.label",
"path": "PlanDefinition.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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.title",
"path": "PlanDefinition.actionDefinition.title",
"short": "User-visible title",
"definition": "The title of the action displayed to a user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.description",
"path": "PlanDefinition.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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.textEquivalent",
"path": "PlanDefinition.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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.code",
"path": "PlanDefinition.actionDefinition.code",
"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"
}
]
},
{
"id": "PlanDefinition.actionDefinition.documentation",
"path": "PlanDefinition.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": "RelatedArtifact"
}
]
},
{
"id": "PlanDefinition.actionDefinition.triggerDefinition",
"path": "PlanDefinition.actionDefinition.triggerDefinition",
"short": "When the action should be triggered",
"definition": "A description of when the action should be triggered.",
"min": 0,
"max": "*",
"type": [
{
"code": "TriggerDefinition"
}
]
},
{
"id": "PlanDefinition.actionDefinition.condition",
"path": "PlanDefinition.actionDefinition.condition",
"short": "Whether or not the action is applicable",
"definition": "An expression that describes applicability criteria, or start/stop conditions for the action.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "PlanDefinition.actionDefinition.condition.kind",
"path": "PlanDefinition.actionDefinition.condition.kind",
"short": "applicability | start | stop",
"definition": "The kind of condition.",
"comments": "Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe when enter/exit criteria for an action.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines the kinds of conditions that can appear on actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-condition-kind"
}
}
},
{
"id": "PlanDefinition.actionDefinition.condition.description",
"path": "PlanDefinition.actionDefinition.condition.description",
"short": "Natural language description of the condition",
"definition": "A brief, natural language description of the condition that effectively communicates the intended semantics.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.condition.language",
"path": "PlanDefinition.actionDefinition.condition.language",
"short": "Language of the expression",
"definition": "The media type of the language for the expression.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.condition.expression",
"path": "PlanDefinition.actionDefinition.condition.expression",
"short": "Boolean-valued expression",
"definition": "An expression that returns true or false, indicating whether or not the condition is satisfied.",
"comments": "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.input",
"path": "PlanDefinition.actionDefinition.input",
"short": "Input data requirements",
"definition": "Defines input data requirements for the action.",
"min": 0,
"max": "*",
"type": [
{
"code": "DataRequirement"
}
]
},
{
"id": "PlanDefinition.actionDefinition.output",
"path": "PlanDefinition.actionDefinition.output",
"short": "Output data definition",
"definition": "Defines the outputs of the action, if any.",
"min": 0,
"max": "*",
"type": [
{
"code": "DataRequirement"
}
]
},
{
"id": "PlanDefinition.actionDefinition.relatedAction",
"path": "PlanDefinition.actionDefinition.relatedAction",
"short": "Relationship to another action",
"definition": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".",
"comments": "When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "PlanDefinition.actionDefinition.relatedAction.actionIdentifier",
"path": "PlanDefinition.actionDefinition.relatedAction.actionIdentifier",
"short": "Identifier of the related action",
"definition": "The unique identifier of the related action.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "PlanDefinition.actionDefinition.relatedAction.relationship",
"path": "PlanDefinition.actionDefinition.relatedAction.relationship",
"short": "before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end",
"definition": "The relationship of this action to the related action.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines the types of relationships between actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-relationship-type"
}
}
},
{
"id": "PlanDefinition.actionDefinition.relatedAction.offset[x]",
"path": "PlanDefinition.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": "Duration"
},
{
"code": "Range"
}
]
},
{
"id": "PlanDefinition.actionDefinition.timing[x]",
"path": "PlanDefinition.actionDefinition.timing[x]",
"short": "When the action should take place",
"definition": "An optional value describing when the action should be performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Duration"
},
{
"code": "Range"
},
{
"code": "Timing"
}
]
},
{
"id": "PlanDefinition.actionDefinition.participantType",
"path": "PlanDefinition.actionDefinition.participantType",
"short": "patient | practitioner | related-person",
"definition": "The type of participant in the action.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The type of participant for the action",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-participant-type"
}
}
},
{
"id": "PlanDefinition.actionDefinition.type",
"path": "PlanDefinition.actionDefinition.type",
"short": "create | update | remove | fire-event",
"definition": "The type of action to perform (create, update, remove).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "required",
"description": "The type of action to be performed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-type"
}
}
},
{
"id": "PlanDefinition.actionDefinition.groupingBehavior",
"path": "PlanDefinition.actionDefinition.groupingBehavior",
"short": "visual-group | logical-group | sentence-group",
"definition": "Defines the grouping behavior for the action and its children.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines organization behavior of a group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-grouping-behavior"
}
}
},
{
"id": "PlanDefinition.actionDefinition.selectionBehavior",
"path": "PlanDefinition.actionDefinition.selectionBehavior",
"short": "any | all | all-or-none | exactly-one | at-most-one | one-or-more",
"definition": "Defines the selection behavior for the action and its children.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines selection behavior of a group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-selection-behavior"
}
}
},
{
"id": "PlanDefinition.actionDefinition.requiredBehavior",
"path": "PlanDefinition.actionDefinition.requiredBehavior",
"short": "must | could | must-unless-documented",
"definition": "Defines the requiredness behavior for the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines requiredness behavior for selecting an action or an action group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-required-behavior"
}
}
},
{
"id": "PlanDefinition.actionDefinition.precheckBehavior",
"path": "PlanDefinition.actionDefinition.precheckBehavior",
"short": "yes | no",
"definition": "Defines whether the action should usually be preselected.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines selection frequency behavior for an action or group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-precheck-behavior"
}
}
},
{
"id": "PlanDefinition.actionDefinition.cardinalityBehavior",
"path": "PlanDefinition.actionDefinition.cardinalityBehavior",
"short": "single | multiple",
"definition": "Defines whether the action can be selected multiple times.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines behavior for an action or a group for how many times that item may be repeated",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-cardinality-behavior"
}
}
},
{
"id": "PlanDefinition.actionDefinition.activityDefinition",
"path": "PlanDefinition.actionDefinition.activityDefinition",
"short": "Description of the activity to be performed",
"definition": "A reference to an ActivityDefinition that describes the action to be taken in detail.",
"comments": "Note that the resource is optional, and if no resource is specified, a dynamicValue with a root (/) path can be used to define the entire resource dynamically.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
}
]
},
{
"id": "PlanDefinition.actionDefinition.transform",
"path": "PlanDefinition.actionDefinition.transform",
"short": "Transform to apply the template",
"definition": "A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureMap"
}
]
},
{
"id": "PlanDefinition.actionDefinition.dynamicValue",
"path": "PlanDefinition.actionDefinition.dynamicValue",
"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": "BackboneElement"
}
]
},
{
"id": "PlanDefinition.actionDefinition.dynamicValue.description",
"path": "PlanDefinition.actionDefinition.dynamicValue.description",
"short": "Natural language description of the dynamic value",
"definition": "A brief, natural language description of the intended semantics of the dynamic value.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.dynamicValue.path",
"path": "PlanDefinition.actionDefinition.dynamicValue.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": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.dynamicValue.language",
"path": "PlanDefinition.actionDefinition.dynamicValue.language",
"short": "Language of the expression",
"definition": "The media type of the language for the expression.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.dynamicValue.expression",
"path": "PlanDefinition.actionDefinition.dynamicValue.expression",
"short": "An expression that provides the dynamic value for the customization",
"definition": "An expression specifying the value of the customized element.",
"comments": "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PlanDefinition.actionDefinition.actionDefinition",
"path": "PlanDefinition.actionDefinition.actionDefinition",
"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": "*",
"contentReference": "#PlanDefinition.actionDefinition"
}
]
}
}
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.8.0-10521) generated on Tue, Dec 6, 2016 12:26+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change