Release 4
WorkflowThis page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Clinical Decision Support Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
This is a representation of the json schema for PlanDefinition, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/PlanDefinition",
"$ref": "#/definitions/PlanDefinition",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"PlanDefinition": {
"description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.",
"properties": {
"resourceType": {
"description": "This is a PlanDefinition resource",
"const": "PlanDefinition"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "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.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "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.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "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.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"version": {
"description": "The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "Element.schema.json#/definitions/Element"
},
"name": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the plan definition.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "Element.schema.json#/definitions/Element"
},
"subtitle": {
"description": "An explanatory or alternate title for the plan definition giving additional information about its content.",
"$ref": "#/definitions/string"
},
"_subtitle": {
"description": "Extensions for subtitle",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"status": {
"description": "The status of this plan definition. Enables tracking the life-cycle of the content.",
"enum": [
"draft",
"active",
"retired",
"unknown"
]
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"experimental": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "Element.schema.json#/definitions/Element"
},
"subjectCodeableConcept": {
"description": "A code or group definition that describes the intended subject of the plan definition.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"subjectReference": {
"description": "A code or group definition that describes the intended subject of the plan definition.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"date": {
"description": "The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual that published the plan definition.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "Element.schema.json#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the plan definition from a consumer\u0027s perspective.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"useContext": {
"description": "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.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the plan definition is intended to be used.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this plan definition is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "Element.schema.json#/definitions/Element"
},
"usage": {
"description": "A detailed description of how the plan definition is used from a clinical perspective.",
"$ref": "#/definitions/string"
},
"_usage": {
"description": "Extensions for usage",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyright": {
"description": "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.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "Element.schema.json#/definitions/Element"
},
"approvalDate": {
"description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"$ref": "#/definitions/date"
},
"_approvalDate": {
"description": "Extensions for approvalDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"lastReviewDate": {
"description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"$ref": "#/definitions/date"
},
"_lastReviewDate": {
"description": "Extensions for lastReviewDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"effectivePeriod": {
"description": "The period during which the plan definition content was or is planned to be in active use.",
"$ref": "Period.schema.json#/definitions/Period"
},
"topic": {
"description": "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.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"author": {
"description": "An individiual or organization primarily involved in the creation and maintenance of the content.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"editor": {
"description": "An individual or organization primarily responsible for internal coherence of the content.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"reviewer": {
"description": "An individual or organization primarily responsible for review of some aspect of the content.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"endorser": {
"description": "An individual or organization responsible for officially endorsing the content for use in some setting.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"relatedArtifact": {
"description": "Related artifacts such as additional documentation, justification, or bibliographic references.",
"items": {
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"type": "array"
},
"library": {
"description": "A reference to a Library resource containing any formal logic used by the plan definition.",
"items": {
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": "array"
},
"goal": {
"description": "Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.",
"items": {
"$ref": "#/definitions/PlanDefinition_Goal"
},
"type": "array"
},
"action": {
"description": "An action or group of actions to be taken as part of the plan.",
"items": {
"$ref": "#/definitions/PlanDefinition_Action"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"resourceType"
]
},
"PlanDefinition_Goal": {
"description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"category": {
"description": "Indicates a category the goal falls within.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"description": {
"description": "Human-readable and/or coded description of a specific desired objective of care, such as \"control blood pressure\" or \"negotiate an obstacle course\" or \"dance with child at wedding\".",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"priority": {
"description": "Identifies the expected level of importance associated with reaching/sustaining the defined goal.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"start": {
"description": "The event after which the goal should begin being pursued.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"addresses": {
"description": "Identifies problems, conditions, issues, or concerns the goal is intended to address.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"documentation": {
"description": "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.",
"items": {
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"type": "array"
},
"target": {
"description": "Indicates what should be done and within what timeframe.",
"items": {
"$ref": "#/definitions/PlanDefinition_Target"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"description"
]
},
"PlanDefinition_Target": {
"description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"measure": {
"description": "The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"detailQuantity": {
"description": "The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"detailRange": {
"description": "The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.",
"$ref": "Range.schema.json#/definitions/Range"
},
"detailCodeableConcept": {
"description": "The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"due": {
"description": "Indicates the timeframe after the start of the goal in which the goal should be met.",
"$ref": "Duration.schema.json#/definitions/Duration"
}
},
"additionalProperties": false
},
"PlanDefinition_Action": {
"description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"prefix": {
"description": "A user-visible prefix for the action.",
"$ref": "#/definitions/string"
},
"_prefix": {
"description": "Extensions for prefix",
"$ref": "Element.schema.json#/definitions/Element"
},
"title": {
"description": "The title of the action displayed to a user.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "A brief description of the action used to provide a summary to display to the user.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"textEquivalent": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_textEquivalent": {
"description": "Extensions for textEquivalent",
"$ref": "Element.schema.json#/definitions/Element"
},
"priority": {
"description": "Indicates how quickly the action should be addressed with respect to other actions.",
"$ref": "#/definitions/code"
},
"_priority": {
"description": "Extensions for priority",
"$ref": "Element.schema.json#/definitions/Element"
},
"code": {
"description": "A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"reason": {
"description": "A description of why this action is necessary or appropriate.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"documentation": {
"description": "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.",
"items": {
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"type": "array"
},
"goalId": {
"description": "Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.",
"items": {
"$ref": "#/definitions/id"
},
"type": "array"
},
"_goalId": {
"description": "Extensions for goalId",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"subjectCodeableConcept": {
"description": "A code or group definition that describes the intended subject of the action and its children, if any.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"subjectReference": {
"description": "A code or group definition that describes the intended subject of the action and its children, if any.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"trigger": {
"description": "A description of when the action should be triggered.",
"items": {
"$ref": "TriggerDefinition.schema.json#/definitions/TriggerDefinition"
},
"type": "array"
},
"condition": {
"description": "An expression that describes applicability criteria or start/stop conditions for the action.",
"items": {
"$ref": "#/definitions/PlanDefinition_Condition"
},
"type": "array"
},
"input": {
"description": "Defines input data requirements for the action.",
"items": {
"$ref": "DataRequirement.schema.json#/definitions/DataRequirement"
},
"type": "array"
},
"output": {
"description": "Defines the outputs of the action, if any.",
"items": {
"$ref": "DataRequirement.schema.json#/definitions/DataRequirement"
},
"type": "array"
},
"relatedAction": {
"description": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".",
"items": {
"$ref": "#/definitions/PlanDefinition_RelatedAction"
},
"type": "array"
},
"timingDateTime": {
"description": "An optional value describing when the action should be performed.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$",
"type": "string"
},
"_timingDateTime": {
"description": "Extensions for timingDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"timingAge": {
"description": "An optional value describing when the action should be performed.",
"$ref": "Age.schema.json#/definitions/Age"
},
"timingPeriod": {
"description": "An optional value describing when the action should be performed.",
"$ref": "Period.schema.json#/definitions/Period"
},
"timingDuration": {
"description": "An optional value describing when the action should be performed.",
"$ref": "Duration.schema.json#/definitions/Duration"
},
"timingRange": {
"description": "An optional value describing when the action should be performed.",
"$ref": "Range.schema.json#/definitions/Range"
},
"timingTiming": {
"description": "An optional value describing when the action should be performed.",
"$ref": "Timing.schema.json#/definitions/Timing"
},
"participant": {
"description": "Indicates who should participate in performing the action described.",
"items": {
"$ref": "#/definitions/PlanDefinition_Participant"
},
"type": "array"
},
"type": {
"description": "The type of action to perform (create, update, remove).",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"groupingBehavior": {
"description": "Defines the grouping behavior for the action and its children.",
"enum": [
"visual-group",
"logical-group",
"sentence-group"
]
},
"_groupingBehavior": {
"description": "Extensions for groupingBehavior",
"$ref": "Element.schema.json#/definitions/Element"
},
"selectionBehavior": {
"description": "Defines the selection behavior for the action and its children.",
"enum": [
"any",
"all",
"all-or-none",
"exactly-one",
"at-most-one",
"one-or-more"
]
},
"_selectionBehavior": {
"description": "Extensions for selectionBehavior",
"$ref": "Element.schema.json#/definitions/Element"
},
"requiredBehavior": {
"description": "Defines the required behavior for the action.",
"enum": [
"must",
"could",
"must-unless-documented"
]
},
"_requiredBehavior": {
"description": "Extensions for requiredBehavior",
"$ref": "Element.schema.json#/definitions/Element"
},
"precheckBehavior": {
"description": "Defines whether the action should usually be preselected.",
"enum": [
"yes",
"no"
]
},
"_precheckBehavior": {
"description": "Extensions for precheckBehavior",
"$ref": "Element.schema.json#/definitions/Element"
},
"cardinalityBehavior": {
"description": "Defines whether the action can be selected multiple times.",
"enum": [
"single",
"multiple"
]
},
"_cardinalityBehavior": {
"description": "Extensions for cardinalityBehavior",
"$ref": "Element.schema.json#/definitions/Element"
},
"definitionCanonical": {
"description": "A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.",
"pattern": "^\\S*$",
"type": "string"
},
"_definitionCanonical": {
"description": "Extensions for definitionCanonical",
"$ref": "Element.schema.json#/definitions/Element"
},
"definitionUri": {
"description": "A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.",
"pattern": "^\\S*$",
"type": "string"
},
"_definitionUri": {
"description": "Extensions for definitionUri",
"$ref": "Element.schema.json#/definitions/Element"
},
"transform": {
"description": "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.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"dynamicValue": {
"description": "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\u0027s 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.",
"items": {
"$ref": "#/definitions/PlanDefinition_DynamicValue"
},
"type": "array"
},
"action": {
"description": "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.",
"items": {
"$ref": "#/definitions/PlanDefinition_Action"
},
"type": "array"
}
},
"additionalProperties": false
},
"PlanDefinition_Condition": {
"description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"kind": {
"description": "The kind of condition.",
"enum": [
"applicability",
"start",
"stop"
]
},
"_kind": {
"description": "Extensions for kind",
"$ref": "Element.schema.json#/definitions/Element"
},
"expression": {
"description": "An expression that returns true or false, indicating whether the condition is satisfied.",
"$ref": "Expression.schema.json#/definitions/Expression"
}
},
"additionalProperties": false
},
"PlanDefinition_RelatedAction": {
"description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"actionId": {
"description": "The element id of the related action.",
"$ref": "#/definitions/id"
},
"_actionId": {
"description": "Extensions for actionId",
"$ref": "Element.schema.json#/definitions/Element"
},
"relationship": {
"description": "The relationship of this action to the related action.",
"enum": [
"before-start",
"before",
"before-end",
"concurrent-with-start",
"concurrent",
"concurrent-with-end",
"after-start",
"after",
"after-end"
]
},
"_relationship": {
"description": "Extensions for relationship",
"$ref": "Element.schema.json#/definitions/Element"
},
"offsetDuration": {
"description": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.",
"$ref": "Duration.schema.json#/definitions/Duration"
},
"offsetRange": {
"description": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.",
"$ref": "Range.schema.json#/definitions/Range"
}
},
"additionalProperties": false
},
"PlanDefinition_Participant": {
"description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"type": {
"description": "The type of participant in the action.",
"enum": [
"patient",
"practitioner",
"related-person",
"device"
]
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"role": {
"description": "The role the participant should play in performing the described action.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"additionalProperties": false
},
"PlanDefinition_DynamicValue": {
"description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"path": {
"description": "The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).",
"$ref": "#/definitions/string"
},
"_path": {
"description": "Extensions for path",
"$ref": "Element.schema.json#/definitions/Element"
},
"expression": {
"description": "An expression specifying the value of the customized element.",
"$ref": "Expression.schema.json#/definitions/Expression"
}
},
"additionalProperties": false
}
}
}
®© HL7.org 2011+. FHIR Release 4 (Technical Correction #1) (v4.0.1) generated on Fri, Nov 1, 2019 09:36+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to R3 |
|
Propose a change