{
"description": "A quality specification is for a drug product or drug substance (excipient, API or raw material).",
"_filename": "StructureDefinition-pqcmc-quality-specification.json",
"package_name": "hl7.fhir.us.pq-cmc-fda",
"date": "2024-12-11T13:47:08+00:00",
"derivation": "constraint",
"publisher": "HL7 International / Biomedical Research and Regulation",
"fhirVersion": "5.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166",
"display": "United States of America"
} ]
} ],
"name": "QualitySpecification",
"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/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information",
"identity": "objimpl"
} ],
"abstract": false,
"type": "PlanDefinition",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Quality Specification",
"package_version": "1.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-implements",
"valueUri": "http://hl7.org/fhir/StructureDefinition/MetadataResource"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "brr"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "cnl-0",
"human": "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"source": "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"severity": "warning",
"expression": "name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')"
}, {
"key": "pld-3",
"human": "goalid should reference the id of a goal definition",
"source": "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"severity": "warning",
"expression": "%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()"
}, {
"key": "pld-4",
"human": "targetId should reference the id of an action",
"source": "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"severity": "warning",
"expression": "%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()"
} ],
"path": "PlanDefinition",
"min": 0,
"definition": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.",
"isModifier": false,
"short": "The definition of a plan for a series of actions, independent of any specific patient or context",
"mapping": [ {
"map": "conformance.behavior,clinical.general",
"identity": "w5"
}, {
"map": "Definition",
"identity": "workflow"
}, {
"map": "Act[classCode=GROUPER;moodCode=DEFN]",
"identity": "rim"
} ],
"mustSupport": false,
"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": "id"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.id",
"comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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"
} ],
"mustSupport": false,
"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",
"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"
} ],
"mustSupport": false,
"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 its 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 its meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for 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",
"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"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "PlanDefinition.text",
"condition": [ "dom-6" ],
"comment": "Contained resources do not have a 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "PlanDefinition.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.extension",
"min": 1,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.extension",
"min": 1,
"definition": "A classification of the regulatory status of the specification.",
"isModifier": false,
"short": "Specification Status",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-specification-status-extension" ]
} ],
"mustSupport": true,
"sliceName": "ApprovalStatus",
"max": "1",
"id": "PlanDefinition.extension:ApprovalStatus",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.extension",
"min": 0,
"definition": "Placeholder for providing any comments that are relevant to the specification. [Source: SME Defined]\nExamples: replaces method ABC, using the XYZ facility.",
"isModifier": false,
"short": "Specification Additional Information",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-additional-info-extension" ]
} ],
"mustSupport": false,
"sliceName": "spec-additional-info",
"max": "1",
"id": "PlanDefinition.extension:spec-additional-info",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"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](http://hl7.org/fhir/R5/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 managable, 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"
} ],
"mustSupport": false,
"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": true
}, {
"constraint": [ {
"key": "cnl-1",
"human": "URL should not contain | or # - these characters make processing canonical references problematic",
"source": "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"severity": "warning",
"expression": "exists() implies matches('^[^|# ]+$')"
}, {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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 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"
}, {
"map": ".identifier[scope=BUSN;reliability=ISS]",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"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](http://hl7.org/fhir/R5/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](http://hl7.org/fhir/R5/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",
"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": ".identifier",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.version",
"min": 1,
"definition": "The alphanumeric text assigned by the sponsor to a particular edition of a specification. [Source: SME Defined] Examples: 2.1, 13.2, ST1, 00001, 00002, companyname-001.\nNote: This value should be unique across all specifications for a given material, not just those with the same name",
"isModifier": false,
"short": "Specification Version",
"mapping": [ {
"map": "Definition.version",
"identity": "workflow"
}, {
"map": "FiveWs.version",
"identity": "w5"
}, {
"map": "N/A (to add?)",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"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]. The version SHOULD NOT contain a '#' - see [Business Version](http://hl7.org/fhir/R5/resource.html#bv-format).",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.versionAlgorithm[x]",
"min": 0,
"definition": "Indicates the mechanism used to compare versions to determine which is more current.",
"isModifier": false,
"short": "How to compare versions",
"mapping": [ {
"map": "Definition.versionAlgorithm",
"identity": "workflow"
}, {
"map": "FiveWs.version",
"identity": "w5"
}, {
"map": "N/A (to add?)",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "string"
}, {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/version-algorithm"
},
"max": "1",
"id": "PlanDefinition.versionAlgorithm[x]",
"comment": "If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.versionAlgorithm[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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)",
"mapping": [ {
"map": "Definition.name",
"identity": "workflow"
}, {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.name",
"condition": [ "cnl-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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.title",
"min": 1,
"definition": "The textual identification for the specification. [Source: SME Defined]\nExample: <drug name> 75 mg chewable tablets\nNote: This may include the name of the drug substance, product or the raw material/excipients",
"isModifier": false,
"short": "Specification Title",
"mapping": [ {
"map": "Definition.title",
"identity": "workflow"
}, {
"map": ".title",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.subtitle",
"min": 0,
"definition": "An additional textual identification for the specification [Source: SME Defined].",
"isModifier": false,
"short": "Specification Subtitle",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.type",
"min": 1,
"definition": "A classification of specification related to the kind of entity it is referencing. [Source: SME Defined]\nExamples: Drug product, Drug substance. ",
"isModifier": false,
"short": "Specification Type",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"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
}, {
"path": "PlanDefinition.type.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": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.type.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.type.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 managable, 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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.type.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.type.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 2,
"definition": "A reference to a code defined by a terminology system.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"rules": "closed",
"ordered": false,
"description": "Slice on the coding itself",
"discriminator": [ {
"path": "$this",
"type": "value"
} ]
},
"type": [ {
"code": "Coding"
} ],
"mustSupport": true,
"max": "2",
"id": "PlanDefinition.type.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.type.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": true,
"sliceName": "DefinitionType",
"max": "1",
"id": "PlanDefinition.type.coding:DefinitionType",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"patternCoding": {
"code": "workflow-definition",
"system": "http://terminology.hl7.org/CodeSystem/plan-definition-type",
"display": "Workflow Definition"
},
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.type.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"definition": "A classification of specification related to the kind of the entity it is referencing.",
"isModifier": false,
"short": "Specification Type",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": true,
"sliceName": "SpecType",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-specification-type-terminology"
},
"max": "1",
"id": "PlanDefinition.type.coding:SpecType",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.type.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"isModifier": false,
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.type.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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"
}, {
"map": ".status",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
} ],
"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.\n\nSee guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"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",
"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"
}, {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"meaningWhenMissing": "If absent, this resource is treated as though it is not experimental.",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.subject[x]",
"min": 1,
"definition": "A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.",
"isModifier": false,
"short": "Type of individual the plan definition is focused on",
"mapping": [ {
"map": "Definition.subject",
"identity": "workflow"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/literal-reference" ],
"aggregation": [ "bundled" ],
"targetProfile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-drug-product-handle", "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-routine-drug-substance", "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-excipient" ]
} ],
"mustSupport": true,
"meaningWhenMissing": "Patient",
"max": "1",
"id": "PlanDefinition.subject[x]",
"comment": "Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.date",
"min": 1,
"definition": "The date when the sponsor assigned a date to a specific version. [Source: SME Defined]\nNote: This is the date a particular version of the specification was internally accepted by the submitter.",
"isModifier": false,
"short": "Specification Version Date",
"mapping": [ {
"map": "Definition.date",
"identity": "workflow"
}, {
"map": "FiveWs.recorded",
"identity": "w5"
}, {
"map": ".participation[typeCode=AUT].time",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": true,
"alias": [ "Revision Date" ],
"max": "1",
"id": "PlanDefinition.date",
"comment": "The date is often not tracked until the resource is published, but may be present on draft content. 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.\n\nSee guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.date"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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 responsible for the release and ongoing maintenance of the plan definition.",
"isModifier": false,
"short": "Name of the publisher/steward (organization or individual)",
"mapping": [ {
"map": "Definition.publisher",
"identity": "workflow"
}, {
"map": "FiveWs.witness",
"identity": "w5"
}, {
"map": ".participation[typeCode=AUT].role",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"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",
"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"
}, {
"map": ".participation[typeCode=CALLBCK].role",
"identity": "rim"
} ],
"type": [ {
"code": "ContactDetail"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.contact",
"comment": "May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.contact"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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"
}, {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.description",
"comment": "This description can be used to capture details such as 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",
"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"
}, {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "UsageContext"
} ],
"mustSupport": false,
"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",
"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"
}, {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/jurisdiction",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
} ],
"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.\n\nDEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.jurisdiction"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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": ".reasonCode.text",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"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",
"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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"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",
"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": "N/A (to add?)",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"alias": [ "License", "Restrictions" ],
"max": "1",
"id": "PlanDefinition.copyright",
"comment": "The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.copyright"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.copyrightLabel",
"requirements": "Defines the content expected to be rendered in all representations of the artifact.",
"min": 0,
"definition": "A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').",
"isModifier": false,
"short": "Copyright holder and year(s)",
"mapping": [ {
"map": "Definition.copyrightLabel",
"identity": "workflow"
}, {
"map": "N/A (to add?)",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.copyrightLabel",
"comment": "The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.copyrightLabel"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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 FDA approval status for a specification became effective. [Source: SME Defined]\nNote: If the application is not yet approved, then this is the date of the current submission OR the date of the complete response (CR).\nNote: This is not the application approval status date.",
"isModifier": false,
"short": "Specification Status Date",
"mapping": [ {
"map": "Definition.approvalDate",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "date"
} ],
"mustSupport": true,
"max": "1",
"id": "PlanDefinition.approvalDate",
"comment": "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.\n\nSee guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.approvalDate"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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 by the publisher",
"mapping": [ {
"map": "Definition.lastReviewDate",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "date"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.lastReviewDate",
"comment": "If specified, this date follows the original approval date.\n\nSee guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.lastReviewDate"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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": "N/A (to add?)",
"identity": "rim"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": false,
"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 plan definition intended to be used for the year 2016 might be published in 2015.\n\nSee guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.effectivePeriod"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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"
}, {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"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",
"comment": "DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.topic"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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"
} ],
"mustSupport": false,
"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",
"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",
"mapping": [ {
"map": ".participation[typeCode=AUT]",
"identity": "rim"
} ],
"type": [ {
"code": "ContactDetail"
} ],
"mustSupport": false,
"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",
"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 asserted by the publisher to be 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"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.reviewer",
"comment": "See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.reviewer"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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 asserted by the publisher to be 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"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.endorser",
"comment": "See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.endorser"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"mapping": [ {
"map": ".outboundRelationship[typeCode=DOC,RSON,PREV, DRIV, USE, COMP] {successor would be PREV w/ inversionInd=true; No support for citation}",
"identity": "rim"
} ],
"type": [ {
"code": "RelatedArtifact"
} ],
"mustSupport": false,
"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",
"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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Library" ]
} ],
"mustSupport": false,
"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",
"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": "A goal describes an expected outcome that 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, meeting the acceptance criteria for a test as specified by a quality specification, etc.",
"isModifier": false,
"short": "Acceptance Criteria",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "*",
"id": "PlanDefinition.goal",
"condition": [ "pld-3" ],
"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",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.goal.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "PlanDefinition.goal.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.goal.extension",
"min": 0,
"definition": "A coded value specifying when a particular analytical procedure or measurement is being performed on a substance or a product. [Source: SME Defined] Examples: Release, Stability.\nNote: The concept of 'In-Process' is subsumed by the Release code.\nExample: value changed from 4% to 5% on 01/01/2010) ",
"isModifier": false,
"short": "Acceptance Criteria Additional Information",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-additional-info-extension" ]
} ],
"sliceName": "ac-additional-info",
"max": "1",
"id": "PlanDefinition.goal.extension:ac-additional-info",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"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](http://hl7.org/fhir/R5/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 managable, 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",
"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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.description",
"min": 1,
"definition": "The text of the acceptance criteria as provided in the specification. [Source: SME Defined]\nExamples: White to off-white cake; 22.5 - 27.5 mg/ml Note: This is the text as it appears in the Specification.",
"isModifier": false,
"short": "Original Text",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"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",
"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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"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",
"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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.addresses",
"min": 1,
"definition": "A coded value specifying when a particular analytical procedure or measurement is being performed on a substance or a product. [Source: SME Defined] Examples: Release, Stability.\nNote: The concept of 'In-Process' is subsumed by the Release code.",
"isModifier": false,
"short": "Acceptance Criteria Usage",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-usage-terminology"
},
"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",
"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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "RelatedArtifact"
} ],
"mustSupport": false,
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cmc-target-range",
"human": "When the Range extension is present, detail cannot be present.",
"source": "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-quality-specification",
"severity": "error",
"expression": "modifierExtension.where(url = 'http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-target-range').exists() implies detail.exists().not()"
} ],
"path": "PlanDefinition.goal.target",
"min": 1,
"definition": "Indicates what should be done and within what timeframe.",
"isModifier": false,
"short": "Acceptance Criteron",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"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",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"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 managable, 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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.goal.target.modifierExtension",
"min": 0,
"definition": "An Extension",
"isModifier": true,
"short": "Extension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "PlanDefinition.goal.target.modifierExtension",
"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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.goal.target.modifierExtension",
"min": 0,
"definition": "The FHIR Range datatype uses Simple Quantities to represent the high and low bounds, which do not allow a comparator to be set. This extension allows the high and low bounds to have a comparator",
"isModifier": true,
"short": "Target Range",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-target-range" ]
} ],
"mustSupport": true,
"sliceName": "targetRange",
"max": "1",
"id": "PlanDefinition.goal.target.modifierExtension:targetRange",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "When present, the target cannot have a detail; instead this extension acts as its detail"
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.target.measure",
"min": 0,
"definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"isModifier": false,
"short": "Detailed parameter being measured if more granular than Sub-Test",
"mapping": [ {
"map": "n/a,CD",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
} ],
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/codeable-concept-text-only" ]
} ],
"mustSupport": true,
"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",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.goal.target.measure"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. 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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"slicing": {
"rules": "closed",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
},
"type": [ {
"code": "Quantity"
}, {
"code": "string"
}, {
"code": "integer"
} ],
"mustSupport": true,
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]",
"comment": "A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.",
"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",
"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 acceptable quantitative or numeric value for the result of the test. [Source: SME Defined]",
"isModifier": false,
"short": "ValueNumeric",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity"
} ],
"mustSupport": true,
"sliceName": "detailQuantity",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure"
},
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]:detailQuantity",
"comment": "A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.goal.target.detail[x]"
},
"isSummary": false
}, {
"path": "PlanDefinition.goal.target.detail[x].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": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]:detailQuantity.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.goal.target.detail[x].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 managable, 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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.goal.target.detail[x]:detailQuantity.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.target.detail[x].value",
"requirements": "Precision is handled implicitly in almost all cases of measurement.",
"min": 1,
"definition": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
"isModifier": false,
"short": "Numerical value (with implicit precision)",
"mapping": [ {
"map": "SN.2 / CQ - N/A",
"identity": "v2"
}, {
"map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value",
"identity": "rim"
} ],
"type": [ {
"code": "decimal"
} ],
"mustSupport": true,
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]:detailQuantity.value",
"comment": "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.target.detail[x].comparator",
"requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min": 0,
"definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.",
"isModifier": true,
"short": "< | <= | >= | > | ad - how to understand the value",
"mapping": [ {
"map": "SN.1 / CQ.1",
"identity": "v2"
}, {
"map": "IVL properties",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"meaningWhenMissing": "If there is no comparator, then there is no modification of the value",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuantityComparator"
} ],
"description": "How the Quantity should be understood and represented."
},
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]:detailQuantity.comparator",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.comparator"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.target.detail[x].unit",
"requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.",
"min": 1,
"definition": "A human-readable form of the unit.",
"isModifier": false,
"short": "Unit representation",
"mapping": [ {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "PQ.unit",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]:detailQuantity.unit",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.unit"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.target.detail[x].system",
"requirements": "Need to know the system that defines the coded form of the unit.",
"min": 0,
"definition": "The identification of the system that provides the coded form of the unit.",
"isModifier": false,
"short": "System that defines coded unit form",
"mapping": [ {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "CO.codeSystem, PQ.translation.codeSystem",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]:detailQuantity.system",
"condition": [ "qty-3" ],
"base": {
"max": "1",
"min": 0,
"path": "Quantity.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.goal.target.detail[x].code",
"requirements": "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.",
"min": 1,
"definition": "A computer processable form of the unit in some unit representation system.",
"isModifier": false,
"short": "Coded form of the unit",
"mapping": [ {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "PQ.code, MO.currency, PQ.translation.code",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]:detailQuantity.code",
"condition": [ "qty-3" ],
"comment": "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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": "A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>)\nNote: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - USP <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)",
"isModifier": false,
"short": "Value",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"sliceName": "detailString",
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]:detailString",
"comment": "A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.",
"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",
"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": "An identification number for a member of the set of results for a test, usually the sequence order in which the test was executed. Individual tests are executed on multiple samples to give greater validity to the findings. [Source SME Defined] \nExamples: Prepare six aliquots from the sample. Test 8 samples. If any fall above 110%, test an additional 7 samples. Record all replicate values as stated in the method.",
"isModifier": false,
"short": "Number of Replicates",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "integer"
} ],
"mustSupport": true,
"sliceName": "detailInteger",
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]:detailInteger",
"comment": "A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.",
"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",
"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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "Duration"
} ],
"mustSupport": false,
"max": "0",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.actor",
"min": 0,
"definition": "Actors represent the individuals or groups involved in the execution of the defined set of activities.",
"isModifier": false,
"short": "Actors within the plan",
"mapping": [ {
"map": ".participation[typeCode=PFM]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.actor",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.actor"
},
"isSummary": false
}, {
"path": "PlanDefinition.actor.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.actor.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.actor.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 managable, 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.actor.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.actor.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](http://hl7.org/fhir/R5/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 managable, 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.actor.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.actor.title",
"min": 0,
"definition": "A descriptive label for the actor.",
"isModifier": false,
"short": "User-visible title",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.actor.title",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.actor.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.actor.description",
"min": 0,
"definition": "A description of how the actor fits into the overall actions of the plan definition.",
"isModifier": false,
"short": "Describes the actor",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.actor.description",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.actor.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.actor.option",
"min": 1,
"definition": "The characteristics of the candidates that could serve as the actor.",
"isModifier": false,
"short": "Who or what can be this actor",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.actor.option",
"base": {
"max": "*",
"min": 1,
"path": "PlanDefinition.actor.option"
},
"isSummary": false
}, {
"path": "PlanDefinition.actor.option.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.actor.option.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.actor.option.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 managable, 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.actor.option.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.actor.option.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](http://hl7.org/fhir/R5/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 managable, 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.actor.option.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.actor.option.type",
"min": 0,
"definition": "The type of participant in the action.",
"isModifier": false,
"short": "careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson",
"mapping": [ {
"map": ".role.classCode",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActivityParticipantType"
} ],
"description": "The type of participant in the activity."
},
"max": "1",
"id": "PlanDefinition.actor.option.type",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.actor.option.type"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.actor.option.typeCanonical",
"min": 0,
"definition": "The type of participant in the action.",
"isModifier": false,
"short": "Who or what can participate",
"mapping": [ {
"map": ".role.classCode",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CapabilityStatement" ]
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.actor.option.typeCanonical",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.actor.option.typeCanonical"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.actor.option.typeReference",
"min": 0,
"definition": "The type of participant in the action.",
"isModifier": false,
"short": "Who or what can participate",
"mapping": [ {
"map": ".role.classCode",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceDefinition", "http://hl7.org/fhir/StructureDefinition/Endpoint", "http://hl7.org/fhir/StructureDefinition/Group", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Location", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ]
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.actor.option.typeReference",
"comment": "When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.actor.option.typeReference"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.actor.option.role",
"min": 0,
"definition": "The role the participant should play in performing the described action.",
"isModifier": false,
"short": "E.g. Nurse, Surgeon, Parent",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/action-participant-role",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionParticipantRole"
} ]
},
"max": "1",
"id": "PlanDefinition.actor.option.role",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.actor.option.role"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cmc-link-required",
"human": "Action linkId is required for alternate tests",
"source": "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-quality-specification",
"severity": "error",
"expression": "(action.relatedAction.count() > 0) implies action.linkId.exists()"
}, {
"key": "cmc-single-or-multistage",
"human": "if a test is multi-stage, the test can't have a prefix and its stages must have a name and can't be named 'Single Stage' and must be unique. If it's single stage its prefix is 'Single Stage' and its groups can't have prefixes",
"source": "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-quality-specification",
"severity": "error",
"expression": "((\n prefix.exists() implies \n action.prefix.empty() and prefix = 'Single Stage' \n) and (\n prefix.empty() implies (\n (action.where(\n prefix.exists() and \n prefix != 'Single Stage'\n ).count() = action.count()) and \n action.prefix.isDistinct()\n )\n)) = true"
} ],
"path": "PlanDefinition.action",
"min": 1,
"definition": "An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.",
"isModifier": false,
"short": "Method",
"mapping": [ {
"map": "{Is a contained Definition}",
"identity": "workflow"
}, {
"map": "Act[classCode=ACT; moodCode=DEFN]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "*",
"id": "PlanDefinition.action",
"condition": [ "pld-3", "pld-4" ],
"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",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"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 managable, 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",
"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",
"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](http://hl7.org/fhir/R5/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 managable, 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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.linkId",
"min": 0,
"definition": "An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.",
"isModifier": false,
"short": "only required for alternate tests",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "PlanDefinition.action.linkId",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.linkId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.prefix",
"min": 0,
"definition": "A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>)\nNote: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)\n\nImplememtation Note: Value at this level is 'Single Stage'",
"isModifier": false,
"short": "Stage Name",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.title",
"min": 1,
"definition": "The textual description of a procedure or analytical method. [Source: SME Defined]\nExamples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities.\nNote: as defined by the sponsor",
"isModifier": false,
"short": "Test Name",
"mapping": [ {
"map": "Definition.title",
"identity": "workflow"
}, {
"map": ".title",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.description",
"min": 0,
"definition": "Test Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined].\nIf there is more than one comment, include in this element. Markdown allows formating for clarity.",
"isModifier": false,
"short": "Test Additional Information",
"mapping": [ {
"map": "Definition.description",
"identity": "workflow"
}, {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"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",
"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"
}, {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"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",
"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",
"mapping": [ {
"map": ".priority",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-priority|5.0.0",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.code",
"min": 1,
"definition": "A coded value specifying the source of the method. [Source: SME Defined] Example: Compendial",
"isModifier": false,
"short": "Test Method Origin",
"mapping": [ {
"map": ".classCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/action-code",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionCode"
} ],
"description": "Provides examples of actions to be performed."
},
"max": "1",
"id": "PlanDefinition.action.code",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.code"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.code.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": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.action.code.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.code.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 managable, 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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.action.code.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.code.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-method-origin-terminology"
},
"max": "1",
"id": "PlanDefinition.action.code.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.code.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 1,
"definition": "The name of the technique used to determine the nature of a characteristic. [Source: SME Defined].",
"isModifier": false,
"short": "Analytical Procedure",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.code.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.reason",
"min": 1,
"definition": "A high level grouping of quality attributes for products, substances, raw materials, excipients, intermediates and reagents. [Source: SME Defined] Examples: Assay, Biological Properties.",
"isModifier": false,
"short": "Test Category | Test Subcategory",
"mapping": [ {
"map": ".reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-category-terminology"
},
"max": "2",
"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
}, {
"path": "PlanDefinition.action.reason.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": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.action.reason.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.reason.extension",
"min": 1,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "PlanDefinition.action.reason.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.reason.extension",
"min": 1,
"definition": "Numeric level in the hierarchical value-set. As an example, this extension is used to distinguished between Test Category | Test Subcategory in Quality Specifications. Test Category is level 1 and Test Subcategory is level two. A constraint enforces values greater than zero.",
"isModifier": false,
"short": "Hierarchical Level",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-hierarchical-level-extension" ]
} ],
"mustSupport": true,
"sliceName": "categoryLevel",
"max": "1",
"id": "PlanDefinition.action.reason.extension:categoryLevel",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.reason.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "PlanDefinition.action.reason.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.reason.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"isModifier": false,
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.reason.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "RelatedArtifact"
} ],
"mustSupport": true,
"max": "1",
"id": "PlanDefinition.action.documentation",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.documentation"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.documentation.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": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.action.documentation.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.documentation.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 managable, 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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.action.documentation.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.documentation.type",
"min": 1,
"definition": "The type of relationship to the related artifact.",
"isModifier": false,
"short": "documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as",
"type": [ {
"code": "code"
} ],
"patternCode": "documentation",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactType"
} ],
"description": "The type of relationship to the related artifact."
},
"max": "1",
"id": "PlanDefinition.action.documentation.type",
"comment": "The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of \"new points to old\" and \"many points to one\", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.",
"base": {
"max": "1",
"min": 1,
"path": "RelatedArtifact.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.documentation.classifier",
"min": 0,
"definition": "Provides additional classifiers of the related artifact.",
"isModifier": false,
"short": "Additional classifiers",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/citation-artifact-classifier",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactClassifier"
} ],
"description": "Additional classifiers for the related artifact."
},
"max": "*",
"id": "PlanDefinition.action.documentation.classifier",
"base": {
"max": "*",
"min": 0,
"path": "RelatedArtifact.classifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.documentation.label",
"min": 1,
"definition": "A sponsor/applicant provided alphanumeric code that identifies the procedure. [Source: SME Defined]. Example: HP1234-2008\nNote: This could also be a transferred lab method.",
"isModifier": false,
"short": "Reference to Procedure",
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "PlanDefinition.action.documentation.label",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.label"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.documentation.display",
"min": 0,
"definition": "A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.",
"isModifier": false,
"short": "Brief description of the related artifact",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.action.documentation.display",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.documentation.citation",
"min": 0,
"definition": "A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.",
"isModifier": false,
"short": "Bibliographic citation for the artifact",
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "PlanDefinition.action.documentation.citation",
"comment": "Additional structured information about citations should be captured as extensions.",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.citation"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.documentation.document",
"min": 0,
"definition": "The document being referenced, represented as an attachment. This is exclusive with the resource element.",
"isModifier": false,
"short": "What document is being referenced",
"type": [ {
"code": "Attachment"
} ],
"max": "1",
"id": "PlanDefinition.action.documentation.document",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.document"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.documentation.resource",
"min": 0,
"definition": "The related artifact, such as a library, value set, profile, or other knowledge resource.",
"isModifier": false,
"short": "What artifact is being referenced",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"max": "1",
"id": "PlanDefinition.action.documentation.resource",
"comment": "If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.resource"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.documentation.resourceReference",
"min": 0,
"definition": "The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.",
"isModifier": false,
"short": "What artifact, if not a conformance resource",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"max": "1",
"id": "PlanDefinition.action.documentation.resourceReference",
"comment": "If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.resourceReference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.documentation.publicationStatus",
"min": 0,
"definition": "The publication status of the artifact being referred to.",
"isModifier": false,
"short": "draft | active | retired | unknown",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactPublicationStatus"
} ],
"description": "Publication status of an artifact being referred to."
},
"max": "1",
"id": "PlanDefinition.action.documentation.publicationStatus",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.publicationStatus"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.documentation.publicationDate",
"min": 0,
"definition": "The date of publication of the artifact being referred to.",
"isModifier": false,
"short": "Date of publication of the artifact being referred to",
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "PlanDefinition.action.documentation.publicationDate",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.publicationDate"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.",
"isModifier": false,
"short": "Reference to Acceptance Criteria",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"mustSupport": true,
"max": "*",
"id": "PlanDefinition.action.goalId",
"condition": [ "pld-3" ],
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.goalId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.",
"isModifier": false,
"short": "Type of individual the action is focused on",
"mapping": [ {
"map": "Definition.subject",
"identity": "workflow"
}, {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Group" ]
}, {
"code": "canonical"
} ],
"mustSupport": false,
"meaningWhenMissing": "Patient",
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/participant-resource-types",
"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",
"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. When multiple triggers are specified on an action, any triggering event invokes the action.",
"isModifier": false,
"short": "When the action should be triggered",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "TriggerDefinition"
} ],
"mustSupport": false,
"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",
"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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"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",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"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 managable, 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",
"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",
"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](http://hl7.org/fhir/R5/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 managable, 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",
"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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0",
"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",
"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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "Expression"
} ],
"mustSupport": false,
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "pld-0",
"human": "Input data elements must have a requirement or a relatedData, but not both",
"source": "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"severity": "error",
"expression": "requirement.exists() xor relatedData.exists()"
} ],
"path": "PlanDefinition.action.input",
"min": 0,
"definition": "Defines input data requirements for the action.",
"isModifier": false,
"short": "Input data requirements",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.input",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.input"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.input.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.input.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.input.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 managable, 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.input.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.input.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](http://hl7.org/fhir/R5/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 managable, 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.input.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.input.title",
"min": 0,
"definition": "A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.",
"isModifier": false,
"short": "User-visible title",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.input.title",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.input.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.input.requirement",
"min": 0,
"definition": "Defines the data that is to be provided as input to the action.",
"isModifier": false,
"short": "What data is provided",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "DataRequirement"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.input.requirement",
"condition": [ "pld-0" ],
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.input.requirement"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.input.relatedData",
"min": 0,
"definition": "Points to an existing input or output element that provides data to this input.",
"isModifier": false,
"short": "What data is provided",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.input.relatedData",
"condition": [ "pld-0" ],
"comment": "The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.input.relatedData"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "pld-1",
"human": "Output data element must have a requirement or a relatedData, but not both",
"source": "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"severity": "error",
"expression": "requirement.exists() xor relatedData.exists()"
} ],
"path": "PlanDefinition.action.output",
"min": 0,
"definition": "Defines the outputs of the action, if any.",
"isModifier": false,
"short": "Output data definition",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.output",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.output"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.output.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.output.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.output.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 managable, 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.output.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.output.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](http://hl7.org/fhir/R5/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 managable, 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.output.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.output.title",
"min": 0,
"definition": "A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.",
"isModifier": false,
"short": "User-visible title",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.output.title",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.output.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.output.requirement",
"min": 0,
"definition": "Defines the data that results as output from the action.",
"isModifier": false,
"short": "What data is provided",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "DataRequirement"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.output.requirement",
"condition": [ "pld-1" ],
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.output.requirement"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.output.relatedData",
"min": 0,
"definition": "Points to an existing input or output element that is results as output from the action.",
"isModifier": false,
"short": "What data is provided",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.output.relatedData",
"condition": [ "pld-1" ],
"comment": "The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.output.relatedData"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.relatedAction",
"min": 0,
"definition": "Alternate Tests are one or more test that are equivalent often using differnt method or equipment. The tests are used interchangeably and only one is used to satisfy the drug product specificaion.",
"isModifier": false,
"short": "Alternate Test",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "*",
"id": "PlanDefinition.action.relatedAction",
"condition": [ "pld-4" ],
"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",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"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 managable, 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",
"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",
"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](http://hl7.org/fhir/R5/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 managable, 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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.relatedAction.targetId",
"min": 1,
"definition": "The element id of the target related action.",
"isModifier": false,
"short": "What action is this related to",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"mustSupport": true,
"max": "1",
"id": "PlanDefinition.action.relatedAction.targetId",
"condition": [ "pld-4" ],
"base": {
"max": "1",
"min": 1,
"path": "PlanDefinition.action.relatedAction.targetId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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 the start of this action to the related action.",
"isModifier": false,
"short": "Code is concurrent",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"patternCode": "concurrent",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.relatedAction.endRelationship",
"min": 0,
"definition": "The relationship of the end of this action to the related action.",
"isModifier": false,
"short": "before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0",
"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.endRelationship",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.relatedAction.endRelationship"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "Duration"
}, {
"code": "Range"
} ],
"mustSupport": false,
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.timing[x]",
"requirements": "Allows prompting for activities and detection of missed planned activities.",
"min": 0,
"definition": "An optional value describing when the action should be performed.",
"isModifier": false,
"short": "When the action should take place",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "Age"
}, {
"code": "Duration"
}, {
"code": "Range"
}, {
"code": "Timing"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.timing[x]",
"comment": "The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.location",
"requirements": "Helps in planning of activity.",
"min": 0,
"definition": "Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.",
"isModifier": false,
"short": "Where it should happen",
"mapping": [ {
"map": ".participation[typeCode=LOC].role",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"mustSupport": false,
"alias": [ "facility" ],
"max": "1",
"id": "PlanDefinition.action.location",
"comment": "May reference a specific clinical location or may just identify a type of location.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.location"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"mapping": [ {
"map": ".participation[typeCode=PFM]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"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",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"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 managable, 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",
"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",
"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](http://hl7.org/fhir/R5/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 managable, 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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.participant.actorId",
"min": 0,
"definition": "A reference to the id element of the actor who will participate in this action.",
"isModifier": false,
"short": "What actor",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.participant.actorId",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.actorId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.participant.type",
"min": 0,
"definition": "The type of participant in the action.",
"isModifier": false,
"short": "careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson",
"mapping": [ {
"map": ".role.classCode",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActivityParticipantType"
} ],
"description": "The type of participant in the activity."
},
"max": "1",
"id": "PlanDefinition.action.participant.type",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.type"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.participant.typeCanonical",
"min": 0,
"definition": "The type of participant in the action.",
"isModifier": false,
"short": "Who or what can participate",
"mapping": [ {
"map": ".role.classCode",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CapabilityStatement" ]
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.participant.typeCanonical",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.typeCanonical"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.participant.typeReference",
"min": 0,
"definition": "The type of participant in the action.",
"isModifier": false,
"short": "Who or what can participate",
"mapping": [ {
"map": ".role.classCode",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceDefinition", "http://hl7.org/fhir/StructureDefinition/Endpoint", "http://hl7.org/fhir/StructureDefinition/Group", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Location", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ]
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.participant.typeReference",
"comment": "When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.typeReference"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"mapping": [ {
"map": ".role.code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.participant.function",
"min": 0,
"definition": "Indicates how the actor will be involved in the action - author, reviewer, witness, etc.",
"isModifier": false,
"short": "E.g. Author, Reviewer, Witness, etc",
"mapping": [ {
"map": ".role.code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/action-participant-function",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionParticipantFunction"
} ]
},
"max": "1",
"id": "PlanDefinition.action.participant.function",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.function"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"mapping": [ {
"map": ".moodCode { Maybe? this is effectively Create, Update, or Delete }",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"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",
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no grouping behavior is specified but the action has children (i.e. is a group), the grouping behavior is assumed to be `logical-group`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0",
"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",
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no selection behavior is specified but the action has children (i.e. is a group), the selection behavior is assumed to be `all`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-selection-behavior|5.0.0",
"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",
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no required behavior is specified but the action has children (i.e. is a group), the required behavior is assumed to be `could`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-required-behavior|5.0.0",
"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",
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no precheck behavior is specified but the action has children (i.e. is a group), the precheck behavior is assumed to be `no`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-precheck-behavior|5.0.0",
"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",
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no cardinality behavior is specified but the action has children (i.e. is a group), the cardinality behavior is assumed to be `single`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-cardinality-behavior|5.0.0",
"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",
"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, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.",
"isModifier": false,
"short": "Description of the activity to be performed",
"mapping": [ {
"map": "Act[classCode=ACT; moodCode=DEFN]",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/MessageDefinition", "http://hl7.org/fhir/StructureDefinition/ObservationDefinition", "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/Questionnaire", "http://hl7.org/fhir/StructureDefinition/SpecimenDefinition" ]
}, {
"code": "uri"
} ],
"mustSupport": false,
"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",
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureMap" ]
} ],
"mustSupport": false,
"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",
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"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",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"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 managable, 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",
"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",
"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](http://hl7.org/fhir/R5/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 managable, 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",
"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 resolvable 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](http://hl7.org/fhir/R5/fhirpath.html#simple) for full details).",
"isModifier": false,
"short": "The path to the element to be set dynamically",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"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](http://hl7.org/fhir/R5/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",
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Expression"
} ],
"mustSupport": false,
"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",
"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": "Groups or Stages",
"mapping": [ {
"map": "{InverseRelationship of Definition.partOf}",
"identity": "workflow"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "*",
"id": "PlanDefinition.action.action",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.action"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.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.action.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.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 managable, 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.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.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](http://hl7.org/fhir/R5/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 managable, 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.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.linkId",
"min": 0,
"definition": "An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.",
"isModifier": false,
"short": "Unique id for the action in the PlanDefinition",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.linkId",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.linkId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.prefix",
"min": 0,
"definition": "A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>)\nNote: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)\n\nImplememtation Note: not requried if action.prefix is 'Single Stage'",
"isModifier": false,
"short": "Stage Name",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.title",
"min": 0,
"definition": "Test Name: The textual description of a procedure or analytical method. [Source: SME Defined]\nExamples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities.\nNote: as defined by the sponsor\nNote: The test name of the action.action can be different than the action. Example, the action test is Microbial Limits and the action.action test is Staphylococcus aureus.",
"isModifier": false,
"short": "Test Name (only reqired if different than above)",
"mapping": [ {
"map": "Definition.title",
"identity": "workflow"
}, {
"map": ".title",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.description",
"min": 0,
"definition": "Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined].\n\nImplementation Note: If there is more than one comment, include in this element. Markdown allows formating for clarity.",
"isModifier": false,
"short": "Test Additional Information | Stage Additional Information",
"mapping": [ {
"map": "Definition.description",
"identity": "workflow"
}, {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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"
}, {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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",
"mapping": [ {
"map": ".priority",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-priority|5.0.0",
"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.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.code",
"min": 0,
"definition": "A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.",
"isModifier": false,
"short": "Code representing the meaning of the action or sub-actions",
"mapping": [ {
"map": ".classCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/action-code",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionCode"
} ],
"description": "Provides examples of actions to be performed."
},
"max": "1",
"id": "PlanDefinition.action.action.code",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.code"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.reason",
"min": 0,
"definition": "A description of why this action is necessary or appropriate.",
"isModifier": false,
"short": "Why the action should be performed",
"mapping": [ {
"map": ".reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/action-reason-code",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionReasonCode"
} ],
"description": "Provides examples of reasons for actions to be performed."
},
"max": "*",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "RelatedArtifact"
} ],
"mustSupport": true,
"max": "*",
"id": "PlanDefinition.action.action.documentation",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.documentation"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.action.documentation.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": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.documentation.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 managable, 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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.action.action.documentation.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.type",
"min": 1,
"definition": "The type of relationship to the related artifact.",
"isModifier": false,
"short": "documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as",
"type": [ {
"code": "code"
} ],
"patternCode": "documentation",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactType"
} ],
"description": "The type of relationship to the related artifact."
},
"max": "1",
"id": "PlanDefinition.action.action.documentation.type",
"comment": "The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of \"new points to old\" and \"many points to one\", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.",
"base": {
"max": "1",
"min": 1,
"path": "RelatedArtifact.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.classifier",
"min": 0,
"definition": "Provides additional classifiers of the related artifact.",
"isModifier": false,
"short": "Additional classifiers",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/citation-artifact-classifier",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactClassifier"
} ],
"description": "Additional classifiers for the related artifact."
},
"max": "*",
"id": "PlanDefinition.action.action.documentation.classifier",
"base": {
"max": "*",
"min": 0,
"path": "RelatedArtifact.classifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.label",
"min": 0,
"definition": "A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.",
"isModifier": false,
"short": "Short label",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.label",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.label"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.display",
"min": 0,
"definition": "A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.",
"isModifier": false,
"short": "Brief description of the related artifact",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.display",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.citation",
"min": 0,
"definition": "A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.",
"isModifier": false,
"short": "Bibliographic citation for the artifact",
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.citation",
"comment": "Additional structured information about citations should be captured as extensions.",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.citation"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document",
"min": 1,
"definition": "Any visual data described andor referenced in additional informatation",
"isModifier": false,
"short": "Test or Stage Additional Information Visual Attachments",
"type": [ {
"code": "Attachment"
} ],
"mustSupport": true,
"max": "1",
"id": "PlanDefinition.action.action.documentation.document",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.document"
},
"isSummary": true
}, {
"path": "PlanDefinition.action.action.documentation.document.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": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.documentation.document.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 managable, 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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "PlanDefinition.action.action.documentation.document.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document.contentType",
"requirements": "Processors of the data need to be able to know how to interpret the data.",
"min": 1,
"definition": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.",
"isModifier": false,
"short": "Mime type of the content, with charset etc.",
"mapping": [ {
"map": "ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used",
"identity": "v2"
}, {
"map": "./mediaType, ./charset",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
} ],
"description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)"
},
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.contentType",
"condition": [ "att-1" ],
"example": [ {
"label": "General",
"valueCode": "text/plain; charset=UTF-8, image/png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.contentType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document.language",
"requirements": "Users need to be able to choose between the languages in a set of attachments.",
"min": 0,
"definition": "The human language of the content. The value can be any valid value according to BCP 47.",
"isModifier": false,
"short": "Human language of the content (BCP-47)",
"mapping": [ {
"map": "./language",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language."
},
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.language",
"example": [ {
"label": "General",
"valueCode": "en-AU"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.language"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document.data",
"requirements": "The data needs to able to be transmitted inline.",
"min": 1,
"definition": "The actual data of the attachment - a sequence of bytes, base64 encoded.",
"isModifier": false,
"short": "Data inline, base64ed",
"mapping": [ {
"map": "ED.5",
"identity": "v2"
}, {
"map": "./data",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"mustSupport": true,
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.data",
"condition": [ "att-1" ],
"comment": "The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.data"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document.url",
"requirements": "The data needs to be transmitted by reference.",
"min": 0,
"definition": "A location where the data can be accessed.",
"isModifier": false,
"short": "Uri where the data can be found",
"mapping": [ {
"map": "RP.1+RP.2 - if they refer to a URL (see v2.6)",
"identity": "v2"
}, {
"map": "./reference/literal",
"identity": "rim"
} ],
"type": [ {
"code": "url"
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.url",
"comment": "If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.",
"example": [ {
"label": "General",
"valueUrl": "http://www.acme.com/logo-small.png"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.url"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document.size",
"requirements": "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.",
"min": 0,
"definition": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).",
"isModifier": false,
"short": "Number of bytes of content (if url provided)",
"mapping": [ {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "integer64"
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.size",
"comment": "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.size"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document.hash",
"requirements": "Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).",
"min": 0,
"definition": "The calculated hash of the data using SHA-1. Represented using base64.",
"isModifier": false,
"short": "Hash of the data (sha-1, base64ed)",
"mapping": [ {
"map": ".integrityCheck[parent::ED/integrityCheckAlgorithm=\"SHA-1\"]",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.hash",
"comment": "The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](http://hl7.org/fhir/R5/provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.hash"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document.title",
"requirements": "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.",
"min": 1,
"definition": "A format or abbreviation name that identifies a file structure. [Source: SME Defined]\nUsed for the following: Analytical Instrument Data File Type, Impurity Analysis Graphic, Impurity Analytical Instrument Data File, Impurity Chemical Structure Data File, and Substance Structure Graphic.",
"isModifier": false,
"short": "Document file name including the file extension",
"mapping": [ {
"map": "./title/data",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.title",
"comment": "May sometimes be derived from the source filename.",
"example": [ {
"label": "General",
"valueString": "Official Corporate Logo"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Attachment.title"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document.creation",
"requirements": "This is often tracked as an integrity issue for use of the attachment.",
"min": 0,
"definition": "The date that the attachment was first created.",
"isModifier": false,
"short": "Date attachment was first created",
"mapping": [ {
"map": "N/A (needs data type R3 proposal)",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.creation",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.creation"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document.height",
"min": 0,
"definition": "Height of the image in pixels (photo/video).",
"isModifier": false,
"short": "Height of the image in pixels (photo/video)",
"mapping": [ {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.height",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.height"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document.width",
"min": 0,
"definition": "Width of the image in pixels (photo/video).",
"isModifier": false,
"short": "Width of the image in pixels (photo/video)",
"mapping": [ {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.width",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.width"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document.frames",
"min": 0,
"definition": "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.",
"isModifier": false,
"short": "Number of frames if > 1 (photo)",
"mapping": [ {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.frames",
"comment": "if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.frames"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document.duration",
"min": 0,
"definition": "The duration of the recording in seconds - for audio and video.",
"isModifier": false,
"short": "Length in seconds (audio / video)",
"mapping": [ {
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "decimal"
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.duration",
"comment": "The duration might differ from occurrencePeriod if recording was paused.",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.duration"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.document.pages",
"min": 0,
"definition": "The number of pages when printed.",
"isModifier": false,
"short": "Number of printed pages",
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.document.pages",
"base": {
"max": "1",
"min": 0,
"path": "Attachment.pages"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.resource",
"min": 0,
"definition": "The related artifact, such as a library, value set, profile, or other knowledge resource.",
"isModifier": false,
"short": "What artifact is being referenced",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.resource",
"comment": "If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.resource"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.resourceReference",
"min": 0,
"definition": "The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.",
"isModifier": false,
"short": "What artifact, if not a conformance resource",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.resourceReference",
"comment": "If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.resourceReference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.publicationStatus",
"min": 0,
"definition": "The publication status of the artifact being referred to.",
"isModifier": false,
"short": "draft | active | retired | unknown",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactPublicationStatus"
} ],
"description": "Publication status of an artifact being referred to."
},
"max": "1",
"id": "PlanDefinition.action.action.documentation.publicationStatus",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.publicationStatus"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.documentation.publicationDate",
"min": 0,
"definition": "The date of publication of the artifact being referred to.",
"isModifier": false,
"short": "Date of publication of the artifact being referred to",
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "PlanDefinition.action.action.documentation.publicationDate",
"base": {
"max": "1",
"min": 0,
"path": "RelatedArtifact.publicationDate"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.goalId",
"min": 0,
"definition": "Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.",
"isModifier": false,
"short": "Reference to Acceptance Criteria",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"mustSupport": true,
"max": "*",
"id": "PlanDefinition.action.action.goalId",
"condition": [ "pld-3" ],
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.goalId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.",
"isModifier": false,
"short": "Type of individual the action is focused on",
"mapping": [ {
"map": "Definition.subject",
"identity": "workflow"
}, {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Group" ]
}, {
"code": "canonical"
} ],
"mustSupport": false,
"meaningWhenMissing": "Patient",
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/participant-resource-types",
"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.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.trigger",
"min": 0,
"definition": "A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.",
"isModifier": false,
"short": "When the action should be triggered",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "TriggerDefinition"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.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.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.action.condition.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.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 managable, 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.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.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](http://hl7.org/fhir/R5/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 managable, 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.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.condition.kind",
"min": 1,
"definition": "The kind of condition.",
"isModifier": false,
"short": "applicability | start | stop",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0",
"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.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "Expression"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "pld-0",
"human": "Input data elements must have a requirement or a relatedData, but not both",
"source": "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"severity": "error",
"expression": "requirement.exists() xor relatedData.exists()"
} ],
"path": "PlanDefinition.action.action.input",
"min": 0,
"definition": "Defines input data requirements for the action.",
"isModifier": false,
"short": "Input data requirements",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.action.input",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.input"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.action.input.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.action.input.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.input.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 managable, 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.action.input.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.input.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](http://hl7.org/fhir/R5/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 managable, 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.action.input.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.input.title",
"min": 0,
"definition": "A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.",
"isModifier": false,
"short": "User-visible title",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.action.input.title",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.input.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.input.requirement",
"min": 0,
"definition": "Defines the data that is to be provided as input to the action.",
"isModifier": false,
"short": "What data is provided",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "DataRequirement"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.input.requirement",
"condition": [ "pld-0" ],
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.input.requirement"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.input.relatedData",
"min": 0,
"definition": "Points to an existing input or output element that provides data to this input.",
"isModifier": false,
"short": "What data is provided",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.input.relatedData",
"condition": [ "pld-0" ],
"comment": "The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.input.relatedData"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "pld-1",
"human": "Output data element must have a requirement or a relatedData, but not both",
"source": "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"severity": "error",
"expression": "requirement.exists() xor relatedData.exists()"
} ],
"path": "PlanDefinition.action.action.output",
"min": 0,
"definition": "Defines the outputs of the action, if any.",
"isModifier": false,
"short": "Output data definition",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.action.output",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.output"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.action.output.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.action.output.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.output.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 managable, 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.action.output.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.output.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](http://hl7.org/fhir/R5/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 managable, 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.action.output.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.output.title",
"min": 0,
"definition": "A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.",
"isModifier": false,
"short": "User-visible title",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.action.output.title",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.output.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.output.requirement",
"min": 0,
"definition": "Defines the data that results as output from the action.",
"isModifier": false,
"short": "What data is provided",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "DataRequirement"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.output.requirement",
"condition": [ "pld-1" ],
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.output.requirement"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.output.relatedData",
"min": 0,
"definition": "Points to an existing input or output element that is results as output from the action.",
"isModifier": false,
"short": "What data is provided",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.output.relatedData",
"condition": [ "pld-1" ],
"comment": "The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.output.relatedData"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.action.relatedAction",
"condition": [ "pld-4" ],
"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.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.action.relatedAction.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.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 managable, 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.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.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](http://hl7.org/fhir/R5/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 managable, 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.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.relatedAction.targetId",
"min": 1,
"definition": "The element id of the target related action.",
"isModifier": false,
"short": "What action is this related to",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.relatedAction.targetId",
"condition": [ "pld-4" ],
"base": {
"max": "1",
"min": 1,
"path": "PlanDefinition.action.relatedAction.targetId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.relatedAction.relationship",
"min": 1,
"definition": "The relationship of the start of this action to the related action.",
"isModifier": false,
"short": "before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionRelationshipType"
} ],
"description": "Defines the types of relationships between actions."
},
"max": "1",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.relatedAction.endRelationship",
"min": 0,
"definition": "The relationship of the end of this action to the related action.",
"isModifier": false,
"short": "before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionRelationshipType"
} ],
"description": "Defines the types of relationships between actions."
},
"max": "1",
"id": "PlanDefinition.action.action.relatedAction.endRelationship",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.relatedAction.endRelationship"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "Duration"
}, {
"code": "Range"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.timing[x]",
"requirements": "Allows prompting for activities and detection of missed planned activities.",
"min": 0,
"definition": "An optional value describing when the action should be performed.",
"isModifier": false,
"short": "When the action should take place",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "Age"
}, {
"code": "Duration"
}, {
"code": "Range"
}, {
"code": "Timing"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.timing[x]",
"comment": "The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.location",
"requirements": "Helps in planning of activity.",
"min": 0,
"definition": "Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.",
"isModifier": false,
"short": "Where it should happen",
"mapping": [ {
"map": ".participation[typeCode=LOC].role",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"mustSupport": false,
"alias": [ "facility" ],
"max": "1",
"id": "PlanDefinition.action.action.location",
"comment": "May reference a specific clinical location or may just identify a type of location.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.location"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.participant",
"min": 0,
"definition": "Indicates who should participate in performing the action described.",
"isModifier": false,
"short": "Who should participate in the action",
"mapping": [ {
"map": ".participation[typeCode=PFM]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.action.participant",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.participant"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.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.action.participant.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.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 managable, 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.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.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](http://hl7.org/fhir/R5/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 managable, 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.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.participant.actorId",
"min": 0,
"definition": "A reference to the id element of the actor who will participate in this action.",
"isModifier": false,
"short": "What actor",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.participant.actorId",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.actorId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.participant.type",
"min": 0,
"definition": "The type of participant in the action.",
"isModifier": false,
"short": "careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson",
"mapping": [ {
"map": ".role.classCode",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActivityParticipantType"
} ],
"description": "The type of participant in the activity."
},
"max": "1",
"id": "PlanDefinition.action.action.participant.type",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.type"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.participant.typeCanonical",
"min": 0,
"definition": "The type of participant in the action.",
"isModifier": false,
"short": "Who or what can participate",
"mapping": [ {
"map": ".role.classCode",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CapabilityStatement" ]
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.participant.typeCanonical",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.typeCanonical"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.participant.typeReference",
"min": 0,
"definition": "The type of participant in the action.",
"isModifier": false,
"short": "Who or what can participate",
"mapping": [ {
"map": ".role.classCode",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceDefinition", "http://hl7.org/fhir/StructureDefinition/Endpoint", "http://hl7.org/fhir/StructureDefinition/Group", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Location", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ]
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.participant.typeReference",
"comment": "When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.typeReference"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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",
"mapping": [ {
"map": ".role.code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/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.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.participant.function",
"min": 0,
"definition": "Indicates how the actor will be involved in the action - author, reviewer, witness, etc.",
"isModifier": false,
"short": "E.g. Author, Reviewer, Witness, etc",
"mapping": [ {
"map": ".role.code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/action-participant-function",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionParticipantFunction"
} ]
},
"max": "1",
"id": "PlanDefinition.action.action.participant.function",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.function"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.type",
"min": 0,
"definition": "The type of action to perform (create, update, remove).",
"isModifier": false,
"short": "create | update | remove | fire-event",
"mapping": [ {
"map": ".moodCode { Maybe? this is effectively Create, Update, or Delete }",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"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.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.groupingBehavior",
"min": 0,
"definition": "Defines the grouping behavior for the action and its children.",
"isModifier": false,
"short": "visual-group | logical-group | sentence-group",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no grouping behavior is specified but the action has children (i.e. is a group), the grouping behavior is assumed to be `logical-group`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionGroupingBehavior"
} ],
"description": "Defines organization behavior of a group."
},
"max": "1",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no selection behavior is specified but the action has children (i.e. is a group), the selection behavior is assumed to be `all`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-selection-behavior|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionSelectionBehavior"
} ],
"description": "Defines selection behavior of a group."
},
"max": "1",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.requiredBehavior",
"min": 0,
"definition": "Defines the required behavior for the action.",
"isModifier": false,
"short": "must | could | must-unless-documented",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no required behavior is specified but the action has children (i.e. is a group), the required behavior is assumed to be `could`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-required-behavior|5.0.0",
"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.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.precheckBehavior",
"min": 0,
"definition": "Defines whether the action should usually be preselected.",
"isModifier": false,
"short": "yes | no",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no precheck behavior is specified but the action has children (i.e. is a group), the precheck behavior is assumed to be `no`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-precheck-behavior|5.0.0",
"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.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.cardinalityBehavior",
"min": 0,
"definition": "Defines whether the action can be selected multiple times.",
"isModifier": false,
"short": "single | multiple",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no cardinality behavior is specified but the action has children (i.e. is a group), the cardinality behavior is assumed to be `single`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-cardinality-behavior|5.0.0",
"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.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.definition[x]",
"min": 0,
"definition": "A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.",
"isModifier": false,
"short": "Description of the activity to be performed",
"mapping": [ {
"map": "Act[classCode=ACT; moodCode=DEFN]",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/MessageDefinition", "http://hl7.org/fhir/StructureDefinition/ObservationDefinition", "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/Questionnaire", "http://hl7.org/fhir/StructureDefinition/SpecimenDefinition" ]
}, {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureMap" ]
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.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.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.action.dynamicValue.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.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 managable, 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.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.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](http://hl7.org/fhir/R5/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 managable, 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.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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 resolvable 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](http://hl7.org/fhir/R5/fhirpath.html#simple) for full details).",
"isModifier": false,
"short": "The path to the element to be set dynamically",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.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](http://hl7.org/fhir/R5/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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Expression"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cmc-subtest-rrt",
"human": "a subtest's prefix represents relative retention time, should it exist",
"source": "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-quality-specification",
"severity": "error",
"expression": "prefix.exists() implies prefix.single() = 'RRT'"
} ],
"path": "PlanDefinition.action.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": "Sub-Test",
"mapping": [ {
"map": "{InverseRelationship of Definition.partOf}",
"identity": "workflow"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "*",
"id": "PlanDefinition.action.action.action",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.action"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.action.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.action.action.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.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 managable, 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.action.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.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](http://hl7.org/fhir/R5/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 managable, 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.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.linkId",
"min": 0,
"definition": "An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.",
"isModifier": false,
"short": "Unique id for the action in the PlanDefinition",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.action.linkId",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.linkId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.prefix",
"min": 0,
"definition": "RRT: The ratio of the retention time of a component relative to that of another used as a reference obtained under identical conditions as an alias for the name of the unidentified impurities. [Source: Adapted from USP] \nExample: 1:23 (a ratio)\nNote: This is the title or name of the impurity (sometimes expressed as a ratio) and not the value.\n\nImplementation Note: This value can only be 'RRT'. It is used to desinate that RRT value(s) expressed in action.action.action.title are relative retention times.",
"isModifier": false,
"short": "RRT",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.title",
"min": 1,
"definition": "Test Name: The textual description of a procedure or analytical method. [Source: SME Defined]\nExamples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities.\nNote: as defined by the sponsor\nNote: The test name of the action.action can be different than the action. Example, the action test is Microbial Limits and the action.action test is Staphylococcus aureus.\n\nRRT: The ratio of the retention time of a component relative to that of another used as a reference obtained under identical conditions as an alias for the name of the unidentified impurities. [Source: Adapted from USP] \nExample: 1:23 (a ratio)\nNote: This is the title or name of the impurity (sometimes expressed as a ratio) and not the value. \n\nImplementation Note: For RRT, if there is a range associated with the unidentified peak then the range can be entered instead of indivual values. E.g.: 0.4 – 0.8.",
"isModifier": false,
"short": "Test Name | RRT (complex testing)",
"mapping": [ {
"map": "Definition.title",
"identity": "workflow"
}, {
"map": ".title",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.description",
"min": 0,
"definition": "Test Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined].\nStage Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined]\nIf there is more than one comment, include in this element. Markdown allows formating for clarity. If both types are present, indicate type.",
"isModifier": false,
"short": "Test Additional Information | Stage Additional Information",
"mapping": [ {
"map": "Definition.description",
"identity": "workflow"
}, {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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"
}, {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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",
"mapping": [ {
"map": ".priority",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-priority|5.0.0",
"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.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.code",
"min": 0,
"definition": "A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.",
"isModifier": false,
"short": "Code representing the meaning of the action or sub-actions",
"mapping": [ {
"map": ".classCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/action-code",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionCode"
} ],
"description": "Provides examples of actions to be performed."
},
"max": "1",
"id": "PlanDefinition.action.action.action.code",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.code"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.reason",
"min": 0,
"definition": "A description of why this action is necessary or appropriate.",
"isModifier": false,
"short": "Why the action should be performed",
"mapping": [ {
"map": ".reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/action-reason-code",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionReasonCode"
} ],
"description": "Provides examples of reasons for actions to be performed."
},
"max": "*",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "RelatedArtifact"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.goalId",
"min": 1,
"definition": "Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.",
"isModifier": false,
"short": "Reference to Acceptance Criteria",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"mustSupport": true,
"max": "*",
"id": "PlanDefinition.action.action.action.goalId",
"condition": [ "pld-3" ],
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.goalId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.",
"isModifier": false,
"short": "Type of individual the action is focused on",
"mapping": [ {
"map": "Definition.subject",
"identity": "workflow"
}, {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Group" ]
}, {
"code": "canonical"
} ],
"mustSupport": false,
"meaningWhenMissing": "Patient",
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/participant-resource-types",
"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.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.trigger",
"min": 0,
"definition": "A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.",
"isModifier": false,
"short": "When the action should be triggered",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "TriggerDefinition"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.action.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.action.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.action.action.condition.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.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 managable, 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.action.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.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](http://hl7.org/fhir/R5/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 managable, 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.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.condition.kind",
"min": 1,
"definition": "The kind of condition.",
"isModifier": false,
"short": "applicability | start | stop",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0",
"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.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "Expression"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "pld-0",
"human": "Input data elements must have a requirement or a relatedData, but not both",
"source": "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"severity": "error",
"expression": "requirement.exists() xor relatedData.exists()"
} ],
"path": "PlanDefinition.action.action.action.input",
"min": 0,
"definition": "Defines input data requirements for the action.",
"isModifier": false,
"short": "Input data requirements",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.action.action.input",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.input"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.action.action.input.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.action.action.input.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.action.input.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 managable, 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.action.action.input.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.action.input.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](http://hl7.org/fhir/R5/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 managable, 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.action.action.input.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.input.title",
"min": 0,
"definition": "A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.",
"isModifier": false,
"short": "User-visible title",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.action.action.input.title",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.input.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.input.requirement",
"min": 0,
"definition": "Defines the data that is to be provided as input to the action.",
"isModifier": false,
"short": "What data is provided",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "DataRequirement"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.action.input.requirement",
"condition": [ "pld-0" ],
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.input.requirement"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.input.relatedData",
"min": 0,
"definition": "Points to an existing input or output element that provides data to this input.",
"isModifier": false,
"short": "What data is provided",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.action.input.relatedData",
"condition": [ "pld-0" ],
"comment": "The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.input.relatedData"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "pld-1",
"human": "Output data element must have a requirement or a relatedData, but not both",
"source": "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"severity": "error",
"expression": "requirement.exists() xor relatedData.exists()"
} ],
"path": "PlanDefinition.action.action.action.output",
"min": 0,
"definition": "Defines the outputs of the action, if any.",
"isModifier": false,
"short": "Output data definition",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.action.action.output",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.output"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.action.action.output.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.action.action.output.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.action.output.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 managable, 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.action.action.output.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.action.output.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](http://hl7.org/fhir/R5/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 managable, 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.action.action.output.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.output.title",
"min": 0,
"definition": "A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.",
"isModifier": false,
"short": "User-visible title",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "PlanDefinition.action.action.action.output.title",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.output.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.output.requirement",
"min": 0,
"definition": "Defines the data that results as output from the action.",
"isModifier": false,
"short": "What data is provided",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "DataRequirement"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.action.output.requirement",
"condition": [ "pld-1" ],
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.output.requirement"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.output.relatedData",
"min": 0,
"definition": "Points to an existing input or output element that is results as output from the action.",
"isModifier": false,
"short": "What data is provided",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.action.output.relatedData",
"condition": [ "pld-1" ],
"comment": "The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.output.relatedData"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.action.action.relatedAction",
"condition": [ "pld-4" ],
"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.action.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.action.action.relatedAction.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.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 managable, 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.action.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.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](http://hl7.org/fhir/R5/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 managable, 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.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.relatedAction.targetId",
"min": 1,
"definition": "The element id of the target related action.",
"isModifier": false,
"short": "What action is this related to",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.action.relatedAction.targetId",
"condition": [ "pld-4" ],
"base": {
"max": "1",
"min": 1,
"path": "PlanDefinition.action.relatedAction.targetId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.relatedAction.relationship",
"min": 1,
"definition": "The relationship of the start of this action to the related action.",
"isModifier": false,
"short": "before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionRelationshipType"
} ],
"description": "Defines the types of relationships between actions."
},
"max": "1",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.relatedAction.endRelationship",
"min": 0,
"definition": "The relationship of the end of this action to the related action.",
"isModifier": false,
"short": "before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionRelationshipType"
} ],
"description": "Defines the types of relationships between actions."
},
"max": "1",
"id": "PlanDefinition.action.action.action.relatedAction.endRelationship",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.relatedAction.endRelationship"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "Duration"
}, {
"code": "Range"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.timing[x]",
"requirements": "Allows prompting for activities and detection of missed planned activities.",
"min": 0,
"definition": "An optional value describing when the action should be performed.",
"isModifier": false,
"short": "When the action should take place",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "Age"
}, {
"code": "Duration"
}, {
"code": "Range"
}, {
"code": "Timing"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.action.timing[x]",
"comment": "The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.location",
"requirements": "Helps in planning of activity.",
"min": 0,
"definition": "Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.",
"isModifier": false,
"short": "Where it should happen",
"mapping": [ {
"map": ".participation[typeCode=LOC].role",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"mustSupport": false,
"alias": [ "facility" ],
"max": "1",
"id": "PlanDefinition.action.action.action.location",
"comment": "May reference a specific clinical location or may just identify a type of location.",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.location"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.participant",
"min": 0,
"definition": "Indicates who should participate in performing the action described.",
"isModifier": false,
"short": "Who should participate in the action",
"mapping": [ {
"map": ".participation[typeCode=PFM]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.action.action.participant",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.participant"
},
"isSummary": false
}, {
"path": "PlanDefinition.action.action.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.action.action.participant.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.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 managable, 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.action.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.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](http://hl7.org/fhir/R5/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 managable, 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.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.participant.actorId",
"min": 0,
"definition": "A reference to the id element of the actor who will participate in this action.",
"isModifier": false,
"short": "What actor",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.action.participant.actorId",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.actorId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.participant.type",
"min": 0,
"definition": "The type of participant in the action.",
"isModifier": false,
"short": "careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson",
"mapping": [ {
"map": ".role.classCode",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActivityParticipantType"
} ],
"description": "The type of participant in the activity."
},
"max": "1",
"id": "PlanDefinition.action.action.action.participant.type",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.type"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.participant.typeCanonical",
"min": 0,
"definition": "The type of participant in the action.",
"isModifier": false,
"short": "Who or what can participate",
"mapping": [ {
"map": ".role.classCode",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CapabilityStatement" ]
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.action.participant.typeCanonical",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.typeCanonical"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.participant.typeReference",
"min": 0,
"definition": "The type of participant in the action.",
"isModifier": false,
"short": "Who or what can participate",
"mapping": [ {
"map": ".role.classCode",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceDefinition", "http://hl7.org/fhir/StructureDefinition/Endpoint", "http://hl7.org/fhir/StructureDefinition/Group", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Location", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ]
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.action.participant.typeReference",
"comment": "When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.typeReference"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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",
"mapping": [ {
"map": ".role.code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/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.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.participant.function",
"min": 0,
"definition": "Indicates how the actor will be involved in the action - author, reviewer, witness, etc.",
"isModifier": false,
"short": "E.g. Author, Reviewer, Witness, etc",
"mapping": [ {
"map": ".role.code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/action-participant-function",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionParticipantFunction"
} ]
},
"max": "1",
"id": "PlanDefinition.action.action.action.participant.function",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.action.participant.function"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.type",
"min": 0,
"definition": "The type of action to perform (create, update, remove).",
"isModifier": false,
"short": "create | update | remove | fire-event",
"mapping": [ {
"map": ".moodCode { Maybe? this is effectively Create, Update, or Delete }",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"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.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.groupingBehavior",
"min": 0,
"definition": "Defines the grouping behavior for the action and its children.",
"isModifier": false,
"short": "visual-group | logical-group | sentence-group",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no grouping behavior is specified but the action has children (i.e. is a group), the grouping behavior is assumed to be `logical-group`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionGroupingBehavior"
} ],
"description": "Defines organization behavior of a group."
},
"max": "1",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no selection behavior is specified but the action has children (i.e. is a group), the selection behavior is assumed to be `all`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-selection-behavior|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActionSelectionBehavior"
} ],
"description": "Defines selection behavior of a group."
},
"max": "1",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.requiredBehavior",
"min": 0,
"definition": "Defines the required behavior for the action.",
"isModifier": false,
"short": "must | could | must-unless-documented",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no required behavior is specified but the action has children (i.e. is a group), the required behavior is assumed to be `could`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-required-behavior|5.0.0",
"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.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.precheckBehavior",
"min": 0,
"definition": "Defines whether the action should usually be preselected.",
"isModifier": false,
"short": "yes | no",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no precheck behavior is specified but the action has children (i.e. is a group), the precheck behavior is assumed to be `no`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-precheck-behavior|5.0.0",
"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.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.cardinalityBehavior",
"min": 0,
"definition": "Defines whether the action can be selected multiple times.",
"isModifier": false,
"short": "single | multiple",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"meaningWhenMissing": "If no cardinality behavior is specified but the action has children (i.e. is a group), the cardinality behavior is assumed to be `single`.",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/action-cardinality-behavior|5.0.0",
"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.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.action.definition[x]",
"min": 0,
"definition": "A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.",
"isModifier": false,
"short": "Description of the activity to be performed",
"mapping": [ {
"map": "Act[classCode=ACT; moodCode=DEFN]",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/MessageDefinition", "http://hl7.org/fhir/StructureDefinition/ObservationDefinition", "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/Questionnaire", "http://hl7.org/fhir/StructureDefinition/SpecimenDefinition" ]
}, {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureMap" ]
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.action.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.action.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.action.action.dynamicValue.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.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 managable, 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.action.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",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "PlanDefinition.action.action.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](http://hl7.org/fhir/R5/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 managable, 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.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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 resolvable 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](http://hl7.org/fhir/R5/fhirpath.html#simple) for full details).",
"isModifier": false,
"short": "The path to the element to be set dynamically",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.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](http://hl7.org/fhir/R5/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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Expression"
} ],
"mustSupport": false,
"max": "1",
"id": "PlanDefinition.action.action.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",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.action.action.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"
}, {
"map": "N/A",
"identity": "rim"
} ],
"contentReference": "http://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action",
"mustSupport": false,
"max": "*",
"id": "PlanDefinition.action.action.action.action",
"base": {
"max": "*",
"min": 0,
"path": "PlanDefinition.action.action"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "PlanDefinition.asNeeded[x]",
"min": 0,
"definition": "If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example \"pain\", \"on flare-up\", etc.",
"isModifier": false,
"short": "Preconditions for service",
"mapping": [ {
"map": "boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false CodeableConcept: precondition.observationEventCriterion[code=\"Assertion\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-as-needed-reason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ProcedureAsNeededReason"
} ],
"description": "A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example \"pain\", \"on flare-up\", etc."
},
"max": "1",
"id": "PlanDefinition.asNeeded[x]",
"base": {
"max": "1",
"min": 0,
"path": "PlanDefinition.asNeeded[x]"
},
"isSummary": true
} ]
},
"status": "active",
"id": "b1cfb823-a097-4634-a1b4-3d9641373de2",
"kind": "resource",
"url": "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-quality-specification",
"identifier": [ {
"value": "urn:oid:2.16.840.1.113883.4.642.40.36.42.30",
"system": "urn:ietf:rfc:3986"
} ],
"version": "1.0.0",
"differential": {
"element": [ {
"id": "PlanDefinition.extension",
"min": 1,
"path": "PlanDefinition.extension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "PlanDefinition.extension:ApprovalStatus",
"max": "1",
"min": 1,
"path": "PlanDefinition.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-specification-status-extension" ]
} ],
"sliceName": "ApprovalStatus",
"mustSupport": true
}, {
"id": "PlanDefinition.extension:spec-additional-info",
"max": "1",
"min": 0,
"path": "PlanDefinition.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-additional-info-extension" ]
} ],
"short": "Specification Additional Information",
"sliceName": "spec-additional-info",
"definition": "Placeholder for providing any comments that are relevant to the specification. [Source: SME Defined]\nExamples: replaces method ABC, using the XYZ facility."
}, {
"id": "PlanDefinition.identifier",
"path": "PlanDefinition.identifier",
"mustSupport": true
}, {
"id": "PlanDefinition.version",
"min": 1,
"path": "PlanDefinition.version",
"short": "Specification Version",
"definition": "The alphanumeric text assigned by the sponsor to a particular edition of a specification. [Source: SME Defined] Examples: 2.1, 13.2, ST1, 00001, 00002, companyname-001.\nNote: This value should be unique across all specifications for a given material, not just those with the same name",
"mustSupport": true
}, {
"id": "PlanDefinition.title",
"min": 1,
"path": "PlanDefinition.title",
"short": "Specification Title",
"definition": "The textual identification for the specification. [Source: SME Defined]\nExample: <drug name> 75 mg chewable tablets\nNote: This may include the name of the drug substance, product or the raw material/excipients",
"mustSupport": true
}, {
"id": "PlanDefinition.subtitle",
"path": "PlanDefinition.subtitle",
"short": "Specification Subtitle",
"definition": "An additional textual identification for the specification [Source: SME Defined].",
"mustSupport": true
}, {
"id": "PlanDefinition.type",
"min": 1,
"path": "PlanDefinition.type",
"short": "Specification Type",
"definition": "A classification of specification related to the kind of entity it is referencing. [Source: SME Defined]\nExamples: Drug product, Drug substance. ",
"mustSupport": true
}, {
"id": "PlanDefinition.type.coding",
"max": "2",
"min": 2,
"path": "PlanDefinition.type.coding",
"slicing": {
"rules": "closed",
"ordered": false,
"description": "Slice on the coding itself",
"discriminator": [ {
"path": "$this",
"type": "value"
} ]
},
"mustSupport": true
}, {
"id": "PlanDefinition.type.coding:DefinitionType",
"max": "1",
"min": 1,
"path": "PlanDefinition.type.coding",
"sliceName": "DefinitionType",
"mustSupport": true,
"patternCoding": {
"code": "workflow-definition",
"system": "http://terminology.hl7.org/CodeSystem/plan-definition-type",
"display": "Workflow Definition"
}
}, {
"path": "PlanDefinition.type.coding",
"min": 1,
"definition": "A classification of specification related to the kind of the entity it is referencing.",
"short": "Specification Type",
"mustSupport": true,
"sliceName": "SpecType",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-specification-type-terminology"
},
"max": "1",
"id": "PlanDefinition.type.coding:SpecType"
}, {
"id": "PlanDefinition.status",
"path": "PlanDefinition.status",
"mustSupport": true
}, {
"id": "PlanDefinition.subject[x]",
"min": 1,
"path": "PlanDefinition.subject[x]",
"type": [ {
"code": "Reference",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/literal-reference" ],
"aggregation": [ "bundled" ],
"targetProfile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-drug-product-handle", "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-routine-drug-substance", "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-excipient" ]
} ],
"mustSupport": true
}, {
"id": "PlanDefinition.date",
"min": 1,
"path": "PlanDefinition.date",
"short": "Specification Version Date",
"definition": "The date when the sponsor assigned a date to a specific version. [Source: SME Defined]\nNote: This is the date a particular version of the specification was internally accepted by the submitter.",
"mustSupport": true
}, {
"id": "PlanDefinition.approvalDate",
"path": "PlanDefinition.approvalDate",
"short": "Specification Status Date",
"definition": "The date on which the FDA approval status for a specification became effective. [Source: SME Defined]\nNote: If the application is not yet approved, then this is the date of the current submission OR the date of the complete response (CR).\nNote: This is not the application approval status date.",
"mustSupport": true
}, {
"id": "PlanDefinition.goal",
"path": "PlanDefinition.goal",
"short": "Acceptance Criteria",
"mustSupport": true
}, {
"id": "PlanDefinition.goal.extension",
"path": "PlanDefinition.goal.extension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "PlanDefinition.goal.extension:ac-additional-info",
"max": "1",
"min": 0,
"path": "PlanDefinition.goal.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-additional-info-extension" ]
} ],
"short": "Acceptance Criteria Additional Information",
"sliceName": "ac-additional-info",
"definition": "A coded value specifying when a particular analytical procedure or measurement is being performed on a substance or a product. [Source: SME Defined] Examples: Release, Stability.\nNote: The concept of 'In-Process' is subsumed by the Release code.\nExample: value changed from 4% to 5% on 01/01/2010) "
}, {
"id": "PlanDefinition.goal.description",
"path": "PlanDefinition.goal.description",
"short": "Original Text",
"definition": "The text of the acceptance criteria as provided in the specification. [Source: SME Defined]\nExamples: White to off-white cake; 22.5 - 27.5 mg/ml Note: This is the text as it appears in the Specification.",
"mustSupport": true
}, {
"id": "PlanDefinition.goal.addresses",
"min": 1,
"path": "PlanDefinition.goal.addresses",
"short": "Acceptance Criteria Usage",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-usage-terminology"
},
"definition": "A coded value specifying when a particular analytical procedure or measurement is being performed on a substance or a product. [Source: SME Defined] Examples: Release, Stability.\nNote: The concept of 'In-Process' is subsumed by the Release code.",
"mustSupport": true
}, {
"id": "PlanDefinition.goal.target",
"min": 1,
"path": "PlanDefinition.goal.target",
"short": "Acceptance Criteron",
"constraint": [ {
"key": "cmc-target-range",
"human": "When the Range extension is present, detail cannot be present.",
"source": "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-quality-specification",
"severity": "error",
"expression": "modifierExtension.where(url = 'http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-target-range').exists() implies detail.exists().not()"
} ],
"mustSupport": true
}, {
"id": "PlanDefinition.goal.target.modifierExtension",
"path": "PlanDefinition.goal.target.modifierExtension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "PlanDefinition.goal.target.modifierExtension:targetRange",
"max": "1",
"min": 0,
"path": "PlanDefinition.goal.target.modifierExtension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-target-range" ]
} ],
"sliceName": "targetRange",
"mustSupport": true
}, {
"id": "PlanDefinition.goal.target.measure",
"path": "PlanDefinition.goal.target.measure",
"type": [ {
"code": "CodeableConcept",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/codeable-concept-text-only" ]
} ],
"short": "Detailed parameter being measured if more granular than Sub-Test",
"mustSupport": true
}, {
"id": "PlanDefinition.goal.target.detail[x]",
"path": "PlanDefinition.goal.target.detail[x]",
"type": [ {
"code": "Quantity"
}, {
"code": "string"
}, {
"code": "integer"
} ],
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
},
"mustSupport": true
}, {
"path": "PlanDefinition.goal.target.detail[x]",
"min": 0,
"definition": "The acceptable quantitative or numeric value for the result of the test. [Source: SME Defined]",
"short": "ValueNumeric",
"type": [ {
"code": "Quantity"
} ],
"mustSupport": true,
"sliceName": "detailQuantity",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure"
},
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]:detailQuantity"
}, {
"id": "PlanDefinition.goal.target.detail[x]:detailQuantity.value",
"min": 1,
"path": "PlanDefinition.goal.target.detail[x].value",
"mustSupport": true
}, {
"id": "PlanDefinition.goal.target.detail[x]:detailQuantity.comparator",
"path": "PlanDefinition.goal.target.detail[x].comparator",
"mustSupport": true
}, {
"id": "PlanDefinition.goal.target.detail[x]:detailQuantity.unit",
"min": 1,
"path": "PlanDefinition.goal.target.detail[x].unit",
"mustSupport": true
}, {
"id": "PlanDefinition.goal.target.detail[x]:detailQuantity.code",
"min": 1,
"path": "PlanDefinition.goal.target.detail[x].code",
"mustSupport": true
}, {
"path": "PlanDefinition.goal.target.detail[x]",
"min": 0,
"definition": "A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>)\nNote: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - USP <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)",
"short": "Value",
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"sliceName": "detailString",
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]:detailString"
}, {
"path": "PlanDefinition.goal.target.detail[x]",
"min": 0,
"definition": "An identification number for a member of the set of results for a test, usually the sequence order in which the test was executed. Individual tests are executed on multiple samples to give greater validity to the findings. [Source SME Defined] \nExamples: Prepare six aliquots from the sample. Test 8 samples. If any fall above 110%, test an additional 7 samples. Record all replicate values as stated in the method.",
"short": "Number of Replicates",
"type": [ {
"code": "integer"
} ],
"mustSupport": true,
"sliceName": "detailInteger",
"max": "1",
"id": "PlanDefinition.goal.target.detail[x]:detailInteger"
}, {
"id": "PlanDefinition.goal.target.due",
"max": "0",
"path": "PlanDefinition.goal.target.due"
}, {
"id": "PlanDefinition.action",
"min": 1,
"path": "PlanDefinition.action",
"short": "Method",
"constraint": [ {
"key": "cmc-link-required",
"human": "Action linkId is required for alternate tests",
"source": "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-quality-specification",
"severity": "error",
"expression": "(action.relatedAction.count() > 0) implies action.linkId.exists()"
}, {
"key": "cmc-single-or-multistage",
"human": "if a test is multi-stage, the test can't have a prefix and its stages must have a name and can't be named 'Single Stage' and must be unique. If it's single stage its prefix is 'Single Stage' and its groups can't have prefixes",
"source": "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-quality-specification",
"severity": "error",
"expression": "((\n prefix.exists() implies \n action.prefix.empty() and prefix = 'Single Stage' \n) and (\n prefix.empty() implies (\n (action.where(\n prefix.exists() and \n prefix != 'Single Stage'\n ).count() = action.count()) and \n action.prefix.isDistinct()\n )\n)) = true"
} ],
"mustSupport": true
}, {
"id": "PlanDefinition.action.linkId",
"path": "PlanDefinition.action.linkId",
"short": "only required for alternate tests",
"mustSupport": true
}, {
"id": "PlanDefinition.action.prefix",
"path": "PlanDefinition.action.prefix",
"short": "Stage Name",
"definition": "A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>)\nNote: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)\n\nImplememtation Note: Value at this level is 'Single Stage'",
"mustSupport": true
}, {
"id": "PlanDefinition.action.title",
"min": 1,
"path": "PlanDefinition.action.title",
"short": "Test Name",
"definition": "The textual description of a procedure or analytical method. [Source: SME Defined]\nExamples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities.\nNote: as defined by the sponsor",
"mustSupport": true
}, {
"id": "PlanDefinition.action.description",
"path": "PlanDefinition.action.description",
"short": "Test Additional Information",
"definition": "Test Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined].\nIf there is more than one comment, include in this element. Markdown allows formating for clarity.",
"mustSupport": true
}, {
"id": "PlanDefinition.action.code",
"min": 1,
"path": "PlanDefinition.action.code",
"short": "Test Method Origin",
"definition": "A coded value specifying the source of the method. [Source: SME Defined] Example: Compendial",
"mustSupport": true
}, {
"id": "PlanDefinition.action.code.coding",
"max": "1",
"min": 1,
"path": "PlanDefinition.action.code.coding",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-method-origin-terminology"
},
"mustSupport": true
}, {
"id": "PlanDefinition.action.code.text",
"min": 1,
"path": "PlanDefinition.action.code.text",
"short": "Analytical Procedure",
"definition": "The name of the technique used to determine the nature of a characteristic. [Source: SME Defined].",
"mustSupport": true
}, {
"id": "PlanDefinition.action.reason",
"max": "2",
"min": 1,
"path": "PlanDefinition.action.reason",
"short": "Test Category | Test Subcategory",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-test-category-terminology"
},
"definition": "A high level grouping of quality attributes for products, substances, raw materials, excipients, intermediates and reagents. [Source: SME Defined] Examples: Assay, Biological Properties.",
"mustSupport": true
}, {
"id": "PlanDefinition.action.reason.extension",
"min": 1,
"path": "PlanDefinition.action.reason.extension"
}, {
"id": "PlanDefinition.action.reason.extension:categoryLevel",
"max": "1",
"min": 1,
"path": "PlanDefinition.action.reason.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-hierarchical-level-extension" ]
} ],
"sliceName": "categoryLevel",
"mustSupport": true
}, {
"id": "PlanDefinition.action.documentation",
"max": "1",
"path": "PlanDefinition.action.documentation",
"mustSupport": true
}, {
"id": "PlanDefinition.action.documentation.type",
"path": "PlanDefinition.action.documentation.type",
"patternCode": "documentation"
}, {
"id": "PlanDefinition.action.documentation.label",
"min": 1,
"path": "PlanDefinition.action.documentation.label",
"short": "Reference to Procedure",
"definition": "A sponsor/applicant provided alphanumeric code that identifies the procedure. [Source: SME Defined]. Example: HP1234-2008\nNote: This could also be a transferred lab method.",
"mustSupport": true
}, {
"id": "PlanDefinition.action.goalId",
"path": "PlanDefinition.action.goalId",
"short": "Reference to Acceptance Criteria",
"mustSupport": true
}, {
"id": "PlanDefinition.action.relatedAction",
"path": "PlanDefinition.action.relatedAction",
"short": "Alternate Test",
"definition": "Alternate Tests are one or more test that are equivalent often using differnt method or equipment. The tests are used interchangeably and only one is used to satisfy the drug product specificaion.",
"mustSupport": true
}, {
"id": "PlanDefinition.action.relatedAction.targetId",
"path": "PlanDefinition.action.relatedAction.targetId",
"mustSupport": true
}, {
"id": "PlanDefinition.action.relatedAction.relationship",
"path": "PlanDefinition.action.relatedAction.relationship",
"short": "Code is concurrent",
"mustSupport": true,
"patternCode": "concurrent"
}, {
"id": "PlanDefinition.action.action",
"path": "PlanDefinition.action.action",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Groups or Stages",
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.prefix",
"path": "PlanDefinition.action.action.prefix",
"short": "Stage Name",
"definition": "A textual description and/or a number that identifies a level within a sequential test. [Source: SME Defined] Examples – Single Stage, Stage 1, Stage 2 (sometimes referred to as L1, L2 L3 or A1, A2 as in USP <711>)\nNote: A Stage may or may not provide a conditional sequence with associated acceptance criteria. [Source: SME Defined] (e.g., dissolution test, pyrogen test - <151>; 21 CFR 610.13 (b) Test for pyrogenic substances)\n\nImplememtation Note: not requried if action.prefix is 'Single Stage'",
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.title",
"path": "PlanDefinition.action.action.title",
"short": "Test Name (only reqired if different than above)",
"definition": "Test Name: The textual description of a procedure or analytical method. [Source: SME Defined]\nExamples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities.\nNote: as defined by the sponsor\nNote: The test name of the action.action can be different than the action. Example, the action test is Microbial Limits and the action.action test is Staphylococcus aureus.",
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.description",
"path": "PlanDefinition.action.action.description",
"short": "Test Additional Information | Stage Additional Information",
"definition": "Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined].\n\nImplementation Note: If there is more than one comment, include in this element. Markdown allows formating for clarity.",
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.documentation",
"path": "PlanDefinition.action.action.documentation",
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.documentation.type",
"path": "PlanDefinition.action.action.documentation.type",
"patternCode": "documentation"
}, {
"id": "PlanDefinition.action.action.documentation.document",
"min": 1,
"path": "PlanDefinition.action.action.documentation.document",
"short": "Test or Stage Additional Information Visual Attachments",
"definition": "Any visual data described andor referenced in additional informatation",
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.documentation.document.contentType",
"min": 1,
"path": "PlanDefinition.action.action.documentation.document.contentType",
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.documentation.document.data",
"min": 1,
"path": "PlanDefinition.action.action.documentation.document.data",
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.documentation.document.title",
"min": 1,
"path": "PlanDefinition.action.action.documentation.document.title",
"short": "Document file name including the file extension",
"definition": "A format or abbreviation name that identifies a file structure. [Source: SME Defined]\nUsed for the following: Analytical Instrument Data File Type, Impurity Analysis Graphic, Impurity Analytical Instrument Data File, Impurity Chemical Structure Data File, and Substance Structure Graphic.",
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.goalId",
"path": "PlanDefinition.action.action.goalId",
"short": "Reference to Acceptance Criteria",
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.action",
"path": "PlanDefinition.action.action.action",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Sub-Test",
"constraint": [ {
"key": "cmc-subtest-rrt",
"human": "a subtest's prefix represents relative retention time, should it exist",
"source": "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-quality-specification",
"severity": "error",
"expression": "prefix.exists() implies prefix.single() = 'RRT'"
} ],
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.action.prefix",
"path": "PlanDefinition.action.action.action.prefix",
"short": "RRT",
"definition": "RRT: The ratio of the retention time of a component relative to that of another used as a reference obtained under identical conditions as an alias for the name of the unidentified impurities. [Source: Adapted from USP] \nExample: 1:23 (a ratio)\nNote: This is the title or name of the impurity (sometimes expressed as a ratio) and not the value.\n\nImplementation Note: This value can only be 'RRT'. It is used to desinate that RRT value(s) expressed in action.action.action.title are relative retention times.",
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.action.title",
"min": 1,
"path": "PlanDefinition.action.action.action.title",
"short": "Test Name | RRT (complex testing)",
"definition": "Test Name: The textual description of a procedure or analytical method. [Source: SME Defined]\nExamples: Assay by HPLC, moisture by Karl Fischer, analysis for impurities.\nNote: as defined by the sponsor\nNote: The test name of the action.action can be different than the action. Example, the action test is Microbial Limits and the action.action test is Staphylococcus aureus.\n\nRRT: The ratio of the retention time of a component relative to that of another used as a reference obtained under identical conditions as an alias for the name of the unidentified impurities. [Source: Adapted from USP] \nExample: 1:23 (a ratio)\nNote: This is the title or name of the impurity (sometimes expressed as a ratio) and not the value. \n\nImplementation Note: For RRT, if there is a range associated with the unidentified peak then the range can be entered instead of indivual values. E.g.: 0.4 – 0.8.",
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.action.description",
"path": "PlanDefinition.action.action.action.description",
"short": "Test Additional Information | Stage Additional Information",
"definition": "Test Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined].\nStage Additional Information: Placeholder for providing any comments that are relevant to the Test. [Source: SME Defined]\nIf there is more than one comment, include in this element. Markdown allows formating for clarity. If both types are present, indicate type.",
"mustSupport": true
}, {
"id": "PlanDefinition.action.action.action.goalId",
"min": 1,
"path": "PlanDefinition.action.action.action.goalId",
"short": "Reference to Acceptance Criteria",
"mustSupport": true
} ]
},
"contact": [ {
"name": "HL7 International / Biomedical Research and Regulation",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/rcrim",
"system": "url"
}, {
"value": "brr@lists.HL7.org",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
}