{
"description": "Israel Core proposed constraints and extensions on the PlanDefinition Resource",
"_filename": "StructureDefinition-il-core-plan-definition.json",
"package_name": "il.core.fhir.r4",
"date": "2024-04-07",
"derivation": "constraint",
"publisher": "Israel Core Team",
"fhirVersion": "4.0.1",
"name": "ILCorePlanDefinition",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information",
"identity": "objimpl"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "PlanDefinition",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "ILCore PlanDefinition Profile",
"package_version": "0.14.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
}, {
"key": "pdf-0",
"human": "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"xpath": "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')",
"severity": "warning",
"expression": "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')"
} ],
"path": "PlanDefinition",
"min": 0,
"definition": "Israel Core proposed constraints and extensions on the PlanDefinition resource profile.",
"isModifier": false,
"short": "ILCore PlanDefinition Profile",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Definition",
"identity": "workflow"
} ],
"max": "*",
"id": "PlanDefinition",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition"
},
"isSummary": false
}, {
"path": "PlanDefinition.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"max": "1",
"id": "PlanDefinition.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "PlanDefinition.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.implicitRules",
"min": 0,
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "PlanDefinition.implicitRules",
"comment": "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "1",
"id": "PlanDefinition.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can 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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "PlanDefinition.text",
"comment": "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 information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "PlanDefinition.contained",
"min": 0,
"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.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "PlanDefinition.contained",
"comment": "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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.url",
"requirements": "Allows the plan definition to be referenced by a single globally unique identifier.",
"min": 0,
"definition": "An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.",
"isModifier": false,
"short": "Canonical identifier for this plan definition, represented as a URI (globally unique)",
"mapping": [ {
"map": "Definition.url",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "PlanDefinition.url",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.url"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.identifier",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional identifier for the plan definition",
"mapping": [ {
"map": "Definition.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "PlanDefinition.identifier",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.version",
"min": 0,
"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 can be placed in a lexicographical sequence. 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.",
"isModifier": false,
"short": "Business version of the plan definition",
"mapping": [ {
"map": "Definition.version",
"identity": "workflow"
}, {
"map": "FiveWs.version",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.version",
"comment": "There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version].",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.name",
"requirements": "Support human navigation and code generation.",
"min": 0,
"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.",
"isModifier": false,
"short": "Name for this plan definition (computer friendly)",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.name",
"condition": [ "inv-0" ],
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.title",
"min": 0,
"definition": "A short, descriptive, user-friendly title for the plan definition.",
"isModifier": false,
"short": "Name for this plan definition (human friendly)",
"mapping": [ {
"map": "Definition.title",
"identity": "workflow"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.title",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.title"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.subtitle",
"min": 0,
"definition": "An explanatory or alternate title for the plan definition giving additional information about its content.",
"isModifier": false,
"short": "Subordinate title of the plan definition",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.subtitle",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.subtitle"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.type",
"min": 0,
"definition": "A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.",
"isModifier": false,
"short": "order-set | clinical-protocol | eca-rule | workflow-definition",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/plan-definition-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PlanDefinitionType"
} ],
"description": "The type of PlanDefinition."
},
"max": "1",
"id": "PlanDefinition.type",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.status",
"min": 1,
"definition": "The status of this plan definition. Enables tracking the life-cycle of the content.",
"isModifier": true,
"short": "draft | active | retired | unknown",
"mapping": [ {
"map": "Definition.status {different ValueSet}",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "PlanDefinition.status",
"comment": "Allows filtering of plan definitions that are appropriate for use versus not.",
"base": {
"max": "1",
"min": 1,
"path": "PlanDefinition.status"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.experimental",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.",
"min": 0,
"definition": "A Boolean value 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.",
"isModifier": false,
"short": "For testing purposes, not real usage",
"mapping": [ {
"map": "Definition.experimental",
"identity": "workflow"
}, {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "PlanDefinition.experimental",
"comment": "Allows filtering of plan definitions that are appropriate for use versus not.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.experimental"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.subject[x]",
"min": 0,
"definition": "A code or group definition that describes the intended subject of the plan definition.",
"isModifier": false,
"short": "Type of individual the plan definition is focused on",
"mapping": [ {
"map": "Definition.subject",
"identity": "workflow"
} ],
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
},
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"meaningWhenMissing": "Patient",
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/subject-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubjectType"
} ],
"description": "The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.)."
},
"max": "1",
"id": "PlanDefinition.subject[x]",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.subject[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.subject[x]",
"min": 0,
"definition": "A code or group definition that describes the intended subject of the plan definition.",
"isModifier": false,
"short": "Type of individual the plan definition is focused on",
"mapping": [ {
"map": "Definition.subject",
"identity": "workflow"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.health.gov.il/StructureDefinition/il-core-group" ]
} ],
"sliceName": "subjectReference",
"meaningWhenMissing": "Patient",
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/subject-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubjectType"
} ],
"description": "The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.)."
},
"max": "1",
"id": "PlanDefinition.subject[x]:subjectReference",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.subject[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.date",
"min": 0,
"definition": "The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.",
"isModifier": false,
"short": "Date last changed",
"mapping": [ {
"map": "Definition.date",
"identity": "workflow"
}, {
"map": "FiveWs.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"alias": [ "Revision Date" ],
"max": "1",
"id": "PlanDefinition.date",
"comment": "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 or be found by consulting Provenances associated with past versions of the resource.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.date"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.publisher",
"requirements": "Helps establish the \"authority/credibility\" of the plan definition. May also allow for contact.",
"min": 0,
"definition": "The name of the organization or individual that published the plan definition.",
"isModifier": false,
"short": "Name of the publisher (organization or individual)",
"mapping": [ {
"map": "Definition.publisher",
"identity": "workflow"
}, {
"map": "FiveWs.witness",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.publisher",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.publisher"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.contact",
"min": 0,
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"isModifier": false,
"short": "Contact details for the publisher",
"mapping": [ {
"map": "Definition.contact",
"identity": "workflow"
} ],
"type": [ {
"code": "ContactDetail"
} ],
"max": "*",
"id": "PlanDefinition.contact",
"comment": "May be a web site, an email address, a telephone number, etc.",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.contact"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.description",
"min": 0,
"definition": "A free text natural language description of the plan definition from a consumer's perspective.",
"isModifier": false,
"short": "Natural language description of the plan definition",
"mapping": [ {
"map": "Definition.description",
"identity": "workflow"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "PlanDefinition.description",
"comment": "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 plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.description"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.useContext",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.",
"isModifier": false,
"short": "The context that the content is intended to support",
"mapping": [ {
"map": "Definition.useContext",
"identity": "workflow"
} ],
"type": [ {
"code": "UsageContext"
} ],
"max": "*",
"id": "PlanDefinition.useContext",
"comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.useContext"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.jurisdiction",
"min": 0,
"definition": "A legal or geographic region in which the plan definition is intended to be used.",
"isModifier": false,
"short": "Intended jurisdiction for plan definition (if applicable)",
"mapping": [ {
"map": "Definition.jurisdiction",
"identity": "workflow"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/jurisdiction",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Countries and regions within which this artifact is targeted for use."
},
"max": "*",
"id": "PlanDefinition.jurisdiction",
"comment": "It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.jurisdiction"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.purpose",
"min": 0,
"definition": "Explanation of why this plan definition is needed and why it has been designed as it has.",
"isModifier": false,
"short": "Why this plan definition is defined",
"mapping": [ {
"map": "Definition.purpose",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "PlanDefinition.purpose",
"comment": "This element does not describe the usage of the plan definition. Instead, it provides 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.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.purpose"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.usage",
"min": 0,
"definition": "A detailed description of how the plan definition is used from a clinical perspective.",
"isModifier": false,
"short": "Describes the clinical usage of the plan",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.usage",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.usage"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.copyright",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.",
"min": 0,
"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.",
"isModifier": false,
"short": "Use and/or publishing restrictions",
"mapping": [ {
"map": "Definition.copyright",
"identity": "workflow"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"alias": [ "License", "Restrictions" ],
"max": "1",
"id": "PlanDefinition.copyright",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.copyright"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.approvalDate",
"min": 0,
"definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"isModifier": false,
"short": "When the plan definition was approved by publisher",
"mapping": [ {
"map": "Definition.approvalDate",
"identity": "workflow"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "PlanDefinition.approvalDate",
"comment": "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.approvalDate"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.lastReviewDate",
"requirements": "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min": 0,
"definition": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"isModifier": false,
"short": "When the plan definition was last reviewed",
"mapping": [ {
"map": "Definition.lastReviewDate",
"identity": "workflow"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "PlanDefinition.lastReviewDate",
"comment": "If specified, this date follows the original approval date.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.lastReviewDate"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.effectivePeriod",
"requirements": "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the plan definition are or are expected to be used instead.",
"min": 0,
"definition": "The period during which the plan definition content was or is planned to be in active use.",
"isModifier": false,
"short": "When the plan definition is expected to be used",
"mapping": [ {
"map": "Definition.effectivePeriod",
"identity": "workflow"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "PlanDefinition.effectivePeriod",
"comment": "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 might be published in 2015.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.effectivePeriod"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.topic",
"requirements": "Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.",
"min": 0,
"definition": "Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.",
"isModifier": false,
"short": "E.g. Education, Treatment, Assessment",
"mapping": [ {
"map": "Definition.subject[x]",
"identity": "workflow"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/definition-topic",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DefinitionTopic"
} ],
"description": "High-level categorization of the definition, used for searching, sorting, and filtering."
},
"max": "*",
"id": "PlanDefinition.topic",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.topic"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.author",
"min": 0,
"definition": "An individiual or organization primarily involved in the creation and maintenance of the content.",
"isModifier": false,
"short": "Who authored the content",
"mapping": [ {
"map": ".participation[typeCode=AUT]",
"identity": "rim"
} ],
"type": [ {
"code": "ContactDetail"
} ],
"max": "*",
"id": "PlanDefinition.author",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.author"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.editor",
"min": 0,
"definition": "An individual or organization primarily responsible for internal coherence of the content.",
"isModifier": false,
"short": "Who edited the content",
"type": [ {
"code": "ContactDetail"
} ],
"max": "*",
"id": "PlanDefinition.editor",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.editor"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.reviewer",
"min": 0,
"definition": "An individual or organization primarily responsible for review of some aspect of the content.",
"isModifier": false,
"short": "Who reviewed the content",
"mapping": [ {
"map": ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}",
"identity": "rim"
} ],
"type": [ {
"code": "ContactDetail"
} ],
"max": "*",
"id": "PlanDefinition.reviewer",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.reviewer"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.endorser",
"min": 0,
"definition": "An individual or organization responsible for officially endorsing the content for use in some setting.",
"isModifier": false,
"short": "Who endorsed the content",
"mapping": [ {
"map": ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}",
"identity": "rim"
} ],
"type": [ {
"code": "ContactDetail"
} ],
"max": "*",
"id": "PlanDefinition.endorser",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.endorser"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.relatedArtifact",
"requirements": "Plan definitions 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,
"definition": "Related artifacts such as additional documentation, justification, or bibliographic references.",
"isModifier": false,
"short": "Additional documentation, citations",
"type": [ {
"code": "RelatedArtifact"
} ],
"max": "*",
"id": "PlanDefinition.relatedArtifact",
"comment": "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.relatedArtifact"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.library",
"min": 0,
"definition": "A reference to a Library resource containing any formal logic used by the plan definition.",
"isModifier": false,
"short": "Logic used by the plan definition",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Library" ]
} ],
"max": "*",
"id": "PlanDefinition.library",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.library"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal",
"requirements": "Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders.",
"min": 0,
"definition": "Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.",
"isModifier": false,
"short": "What the plan is trying to accomplish",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "PlanDefinition.goal",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.goal"
},
"isSummary": false
}, {
"path": "PlanDefinition.goal.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.goal.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.goal.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.goal.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.goal.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "PlanDefinition.goal.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.category",
"min": 0,
"definition": "Indicates a category the goal falls within.",
"isModifier": false,
"short": "E.g. Treatment, dietary, behavioral",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/goal-category",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalCategory"
} ],
"description": "Example codes for grouping goals for filtering or presentation."
},
"max": "1",
"id": "PlanDefinition.goal.category",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.goal.category"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.description",
"min": 1,
"definition": "Human-readable and/or coded description of a specific desired objective of care, such as \"control blood pressure\" or \"negotiate an obstacle course\" or \"dance with child at wedding\".",
"isModifier": false,
"short": "Code or text describing the goal",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalDescription"
} ],
"description": "Describes goals that can be achieved."
},
"max": "1",
"id": "PlanDefinition.goal.description",
"comment": "If no code is available, use CodeableConcept.text.",
"base": {
"max": "1",
"min": 1,
"path": "PlanDefinition.goal.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.priority",
"min": 0,
"definition": "Identifies the expected level of importance associated with reaching/sustaining the defined goal.",
"isModifier": false,
"short": "high-priority | medium-priority | low-priority",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/goal-priority",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalPriority"
} ],
"description": "Indicates the level of importance associated with reaching or sustaining a goal."
},
"max": "1",
"id": "PlanDefinition.goal.priority",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.goal.priority"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.start",
"min": 0,
"definition": "The event after which the goal should begin being pursued.",
"isModifier": false,
"short": "When goal pursuit begins",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/goal-start-event",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalStartEvent"
} ],
"description": "Identifies the types of events that might trigger the start of a goal."
},
"max": "1",
"id": "PlanDefinition.goal.start",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.goal.start"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.addresses",
"min": 0,
"definition": "Identifies problems, conditions, issues, or concerns the goal is intended to address.",
"isModifier": false,
"short": "What does the goal address",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/condition-code",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalAddresses"
} ],
"description": "Identifies problems, conditions, issues, or concerns that goals may address."
},
"max": "*",
"id": "PlanDefinition.goal.addresses",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.goal.addresses"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.documentation",
"min": 0,
"definition": "Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.",
"isModifier": false,
"short": "Supporting documentation for the goal",
"type": [ {
"code": "RelatedArtifact"
} ],
"max": "*",
"id": "PlanDefinition.goal.documentation",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.goal.documentation"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.target",
"min": 0,
"definition": "Indicates what should be done and within what timeframe.",
"isModifier": false,
"short": "Target outcome for the goal",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "PlanDefinition.goal.target",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.goal.target"
},
"isSummary": false
}, {
"path": "PlanDefinition.goal.target.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.goal.target.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.goal.target.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.goal.target.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.goal.target.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "PlanDefinition.goal.target.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.target.measure",
"min": 0,
"definition": "The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.",
"isModifier": false,
"short": "The parameter whose value is to be tracked",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/observation-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalTargetMeasure"
} ],
"description": "Identifies types of parameters that can be tracked to determine goal achievement."
},
"max": "1",
"id": "PlanDefinition.goal.target.measure",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.goal.target.measure"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.target.detail[x]",
"min": 0,
"definition": "The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.",
"isModifier": false,
"short": "The target value to be achieved",
"type": [ {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "CodeableConcept"
} ],
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.goal.target.detail[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.target.due",
"min": 0,
"definition": "Indicates the timeframe after the start of the goal in which the goal should be met.",
"isModifier": false,
"short": "Reach goal within",
"type": [ {
"code": "Duration"
} ],
"max": "1",
"id": "PlanDefinition.goal.target.due",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.goal.target.due"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action",
"min": 0,
"definition": "An action or group of actions to be taken as part of the plan.",
"isModifier": false,
"short": "Action defined by the plan",
"mapping": [ {
"map": "{Is a contained Definition}",
"identity": "workflow"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "PlanDefinition.action",
"comment": "Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.action.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.action.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "PlanDefinition.action.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.prefix",
"min": 0,
"definition": "A user-visible prefix for the action.",
"isModifier": false,
"short": "User-visible prefix for the action (e.g. 1. or A.)",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.action.prefix",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.prefix"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.title",
"min": 0,
"definition": "The title of the action displayed to a user.",
"isModifier": false,
"short": "User-visible title",
"mapping": [ {
"map": "Definition.title",
"identity": "workflow"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.action.title",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.description",
"min": 0,
"definition": "A brief description of the action used to provide a summary to display to the user.",
"isModifier": false,
"short": "Brief description of the action",
"mapping": [ {
"map": "Definition.description",
"identity": "workflow"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.action.description",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.textEquivalent",
"min": 0,
"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 might not be capable of interpreting it dynamically.",
"isModifier": false,
"short": "Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system",
"mapping": [ {
"map": "Definition.description",
"identity": "workflow"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.action.textEquivalent",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.textEquivalent"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.priority",
"min": 0,
"definition": "Indicates how quickly the action should be addressed with respect to other actions.",
"isModifier": false,
"short": "routine | urgent | asap | stat",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-priority|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RequestPriority"
} ],
"description": "Identifies the level of importance to be assigned to actioning the request."
},
"max": "1",
"id": "PlanDefinition.action.priority",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.priority"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.code",
"min": 0,
"definition": "A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.",
"isModifier": false,
"short": "Code representing the meaning of the action or sub-actions",
"type": [ {
"code": "CodeableConcept"
} ],
"max": "*",
"id": "PlanDefinition.action.code",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.code"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.reason",
"min": 0,
"definition": "A description of why this action is necessary or appropriate.",
"isModifier": false,
"short": "Why the action should be performed",
"type": [ {
"code": "CodeableConcept"
} ],
"max": "*",
"id": "PlanDefinition.action.reason",
"comment": "This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.reason"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.documentation",
"min": 0,
"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.",
"isModifier": false,
"short": "Supporting documentation for the intended performer of the action",
"type": [ {
"code": "RelatedArtifact"
} ],
"max": "*",
"id": "PlanDefinition.action.documentation",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.documentation"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.goalId",
"min": 0,
"definition": "Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.",
"isModifier": false,
"short": "What goals this action supports",
"type": [ {
"code": "id"
} ],
"max": "*",
"id": "PlanDefinition.action.goalId",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.goalId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.subject[x]",
"requirements": "Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.",
"min": 0,
"definition": "A code or group definition that describes the intended subject of the action and its children, if any.",
"isModifier": false,
"short": "Type of individual the action is focused on",
"mapping": [ {
"map": "Definition.subject",
"identity": "workflow"
} ],
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"meaningWhenMissing": "Patient",
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/subject-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubjectType"
} ],
"description": "The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.)."
},
"max": "1",
"id": "PlanDefinition.action.subject[x]",
"comment": "The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.\n\nIn addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.subject[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.trigger",
"min": 0,
"definition": "A description of when the action should be triggered.",
"isModifier": false,
"short": "When the action should be triggered",
"type": [ {
"code": "TriggerDefinition"
} ],
"max": "*",
"id": "PlanDefinition.action.trigger",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.trigger"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.condition",
"min": 0,
"definition": "An expression that describes applicability criteria or start/stop conditions for the action.",
"isModifier": false,
"short": "Whether or not the action is applicable",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "PlanDefinition.action.condition",
"comment": "When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.condition"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.condition.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.action.condition.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.condition.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.action.condition.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.condition.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "PlanDefinition.action.condition.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.condition.kind",
"min": 1,
"definition": "The kind of condition.",
"isModifier": false,
"short": "applicability | start | stop",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionConditionKind"
} ],
"description": "Defines the kinds of conditions that can appear on actions."
},
"max": "1",
"id": "PlanDefinition.action.condition.kind",
"comment": "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 enter/exit criteria for an action.",
"base": {
"max": "1",
"min": 1,
"path": "PlanDefinition.action.condition.kind"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.condition.expression",
"min": 0,
"definition": "An expression that returns true or false, indicating whether the condition is satisfied.",
"isModifier": false,
"short": "Boolean-valued expression",
"type": [ {
"code": "Expression"
} ],
"max": "1",
"id": "PlanDefinition.action.condition.expression",
"comment": "The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.condition.expression"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.input",
"min": 0,
"definition": "Defines input data requirements for the action.",
"isModifier": false,
"short": "Input data requirements",
"type": [ {
"code": "DataRequirement"
} ],
"max": "*",
"id": "PlanDefinition.action.input",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.input"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.output",
"min": 0,
"definition": "Defines the outputs of the action, if any.",
"isModifier": false,
"short": "Output data definition",
"type": [ {
"code": "DataRequirement"
} ],
"max": "*",
"id": "PlanDefinition.action.output",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.output"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.relatedAction",
"min": 0,
"definition": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".",
"isModifier": false,
"short": "Relationship to another action",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "PlanDefinition.action.relatedAction",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.relatedAction"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.relatedAction.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.action.relatedAction.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.relatedAction.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.action.relatedAction.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.relatedAction.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "PlanDefinition.action.relatedAction.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.relatedAction.actionId",
"min": 1,
"definition": "The element id of the related action.",
"isModifier": false,
"short": "What action is this related to",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "PlanDefinition.action.relatedAction.actionId",
"base": {
"max": "1",
"min": 1,
"path": "PlanDefinition.action.relatedAction.actionId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.relatedAction.relationship",
"min": 1,
"definition": "The relationship of this action to the related action.",
"isModifier": false,
"short": "before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionRelationshipType"
} ],
"description": "Defines the types of relationships between actions."
},
"max": "1",
"id": "PlanDefinition.action.relatedAction.relationship",
"base": {
"max": "1",
"min": 1,
"path": "PlanDefinition.action.relatedAction.relationship"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.relatedAction.offset[x]",
"min": 0,
"definition": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.",
"isModifier": false,
"short": "Time offset for the relationship",
"type": [ {
"code": "Duration"
}, {
"code": "Range"
} ],
"max": "1",
"id": "PlanDefinition.action.relatedAction.offset[x]",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.relatedAction.offset[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.timing[x]",
"min": 0,
"definition": "An optional value describing when the action should be performed.",
"isModifier": false,
"short": "When the action should take place",
"type": [ {
"code": "dateTime"
}, {
"code": "Age"
}, {
"code": "Period"
}, {
"code": "Duration"
}, {
"code": "Range"
}, {
"code": "Timing"
} ],
"max": "1",
"id": "PlanDefinition.action.timing[x]",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.timing[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.participant",
"min": 0,
"definition": "Indicates who should participate in performing the action described.",
"isModifier": false,
"short": "Who should participate in the action",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "PlanDefinition.action.participant",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.participant"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.participant.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.action.participant.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.participant.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.action.participant.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.participant.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "PlanDefinition.action.participant.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.participant.type",
"min": 1,
"definition": "The type of participant in the action.",
"isModifier": false,
"short": "patient | practitioner | related-person | device",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionParticipantType"
} ],
"description": "The type of participant for the action."
},
"max": "1",
"id": "PlanDefinition.action.participant.type",
"base": {
"max": "1",
"min": 1,
"path": "PlanDefinition.action.participant.type"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.participant.role",
"min": 0,
"definition": "The role the participant should play in performing the described action.",
"isModifier": false,
"short": "E.g. Nurse, Surgeon, Parent",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/action-participant-role",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionParticipantRole"
} ],
"description": "Defines roles played by participants for the action."
},
"max": "1",
"id": "PlanDefinition.action.participant.role",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.role"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.type",
"min": 0,
"definition": "The type of action to perform (create, update, remove).",
"isModifier": false,
"short": "create | update | remove | fire-event",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/action-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionType"
} ],
"description": "The type of action to be performed."
},
"max": "1",
"id": "PlanDefinition.action.type",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.type"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.groupingBehavior",
"min": 0,
"definition": "Defines the grouping behavior for the action and its children.",
"isModifier": false,
"short": "visual-group | logical-group | sentence-group",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionGroupingBehavior"
} ],
"description": "Defines organization behavior of a group."
},
"max": "1",
"id": "PlanDefinition.action.groupingBehavior",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.groupingBehavior"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.selectionBehavior",
"min": 0,
"definition": "Defines the selection behavior for the action and its children.",
"isModifier": false,
"short": "any | all | all-or-none | exactly-one | at-most-one | one-or-more",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionSelectionBehavior"
} ],
"description": "Defines selection behavior of a group."
},
"max": "1",
"id": "PlanDefinition.action.selectionBehavior",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.selectionBehavior"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.requiredBehavior",
"min": 0,
"definition": "Defines the required behavior for the action.",
"isModifier": false,
"short": "must | could | must-unless-documented",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionRequiredBehavior"
} ],
"description": "Defines expectations around whether an action or action group is required."
},
"max": "1",
"id": "PlanDefinition.action.requiredBehavior",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.requiredBehavior"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.precheckBehavior",
"min": 0,
"definition": "Defines whether the action should usually be preselected.",
"isModifier": false,
"short": "yes | no",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionPrecheckBehavior"
} ],
"description": "Defines selection frequency behavior for an action or group."
},
"max": "1",
"id": "PlanDefinition.action.precheckBehavior",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.precheckBehavior"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.cardinalityBehavior",
"min": 0,
"definition": "Defines whether the action can be selected multiple times.",
"isModifier": false,
"short": "single | multiple",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionCardinalityBehavior"
} ],
"description": "Defines behavior for an action or a group for how many times that item may be repeated."
},
"max": "1",
"id": "PlanDefinition.action.cardinalityBehavior",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.cardinalityBehavior"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.definition[x]",
"min": 0,
"definition": "A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.",
"isModifier": false,
"short": "Description of the activity to be performed",
"mapping": [ {
"map": "Definition.derivedFrom",
"identity": "workflow"
} ],
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
},
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/Questionnaire" ]
}, {
"code": "uri"
} ],
"max": "1",
"id": "PlanDefinition.action.definition[x]",
"comment": "Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.definition[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.definition[x]",
"min": 0,
"definition": "A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.",
"isModifier": false,
"short": "Description of the activity to be performed",
"mapping": [ {
"map": "Definition.derivedFrom",
"identity": "workflow"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://fhir.health.gov.il/StructureDefinition/il-core-plan-definition", "http://fhir.health.gov.il/StructureDefinition/il-core-questionnaire" ]
} ],
"sliceName": "definitionCanonical",
"max": "1",
"id": "PlanDefinition.action.definition[x]:definitionCanonical",
"comment": "Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.definition[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.transform",
"min": 0,
"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.",
"isModifier": false,
"short": "Transform to apply the template",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureMap" ]
} ],
"max": "1",
"id": "PlanDefinition.action.transform",
"comment": "Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.transform"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.dynamicValue",
"min": 0,
"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.",
"isModifier": false,
"short": "Dynamic aspects of the definition",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "PlanDefinition.action.dynamicValue",
"comment": "Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.dynamicValue"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.dynamicValue.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.action.dynamicValue.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.dynamicValue.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.action.dynamicValue.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.dynamicValue.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "PlanDefinition.action.dynamicValue.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.dynamicValue.path",
"min": 0,
"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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).",
"isModifier": false,
"short": "The path to the element to be set dynamically",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.action.dynamicValue.path",
"comment": "To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.dynamicValue.path"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.dynamicValue.expression",
"min": 0,
"definition": "An expression specifying the value of the customized element.",
"isModifier": false,
"short": "An expression that provides the dynamic value for the customization",
"type": [ {
"code": "Expression"
} ],
"max": "1",
"id": "PlanDefinition.action.dynamicValue.expression",
"comment": "The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.dynamicValue.expression"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action",
"min": 0,
"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.",
"isModifier": false,
"short": "A sub-action",
"mapping": [ {
"map": "{InverseRelationship of Definition.partOf}",
"identity": "workflow"
} ],
"contentReference": "#PlanDefinition.action",
"max": "*",
"id": "PlanDefinition.action.action",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.action"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "f3628fff-68ea-47c5-803f-197583bde1e5",
"kind": "resource",
"url": "http://fhir.health.gov.il/StructureDefinition/il-core-plan-definition",
"version": "0.14.0",
"differential": {
"element": [ {
"id": "PlanDefinition",
"path": "PlanDefinition",
"short": "ILCore PlanDefinition Profile",
"definition": "Israel Core proposed constraints and extensions on the PlanDefinition resource profile."
}, {
"id": "PlanDefinition.subject[x]",
"path": "PlanDefinition.subject[x]",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
}
}, {
"id": "PlanDefinition.subject[x]:subjectReference",
"max": "1",
"min": 0,
"path": "PlanDefinition.subject[x]",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.health.gov.il/StructureDefinition/il-core-group" ]
} ],
"sliceName": "subjectReference"
}, {
"id": "PlanDefinition.action.definition[x]",
"path": "PlanDefinition.action.definition[x]",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
}
}, {
"id": "PlanDefinition.action.definition[x]:definitionCanonical",
"max": "1",
"min": 0,
"path": "PlanDefinition.action.definition[x]",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://fhir.health.gov.il/StructureDefinition/il-core-plan-definition", "http://fhir.health.gov.il/StructureDefinition/il-core-questionnaire" ]
} ],
"sliceName": "definitionCanonical"
} ]
},
"contact": [ {
"telecom": [ {
"value": "tal.primak@moh.gov.il",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
}