ResMed Core Implementation Guide
0.37.0 - ci-build
ResMed Core Implementation Guide
0.37.0 - ci-build
ResMed Core Implementation Guide - Local Development build (v0.37.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://resmed.com/fhir/core/StructureDefinition/rmd-rule-plandefinition | Version: 0.37.0 | |||
| Draft as of 2024-01-11 | Computable Name: ResMedRulePlanDefinition | |||
Profile for Patient Rule Definitions
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PlanDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PlanDefinition | PlanDefinition | |||
  version | 1..1 | string | Business version of the plan definition | |
| name | 1..1 | string | Name for this plan definition (computer friendly) | |
 type | 1..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-plandefinition-type-identifier | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rule | |
| status | 1..1 | code | draft | active | retired | unknown Binding: ResMed PlanDefinition status ValueSet (required) | |
| useContext | 1..1 | UsageContext | The context that the content is intended to support | |
| code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
 value[x] | 1..1 | CodeableConcept | Value that defines the context Binding: ResMed Rule Implementer Identifier ValueSet (required) | |
| action | 1..* | BackboneElement | Action defined by the plan | |
| trigger | 1..* | TriggerDefinition | When the action should be triggered | |
| data | 1..* | DataRequirement | Triggering data of the event (multiple = 'and') | |
| type | 1..1 | code | The type of the required data Required Pattern: Observation | |
| condition | 1..1 | Expression | Whether the event triggers (boolean expression) | |
| language | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Required Pattern: application/x.rmd-ace+json | |
| expression | 1..1 | string | Expression in specified language | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| PlanDefinition.status | required | ResMedPlanDefinitionStatusValueSet |
| PlanDefinition.useContext.value[x] | required | ResMedRuleImplementerIdentifierValueSet (a valid code from ResMed Rule Implementer Identifier CodeSystem) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | ||||
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| version | Σ | 1..1 | string | Business version of the plan definition | ||||
| name | ΣC | 1..1 | string | Name for this plan definition (computer friendly) | ||||
| type | Σ | 1..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following | ||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-plandefinition-type-identifier | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rule | |||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ResMed PlanDefinition status ValueSet (required) | ||||
| useContext | Σ | 1..1 | UsageContext | The context that the content is intended to support | ||||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following | ||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |||||
| value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ResMed Rule Implementer Identifier ValueSet (required) | ||||
| action | 1..* | BackboneElement | Action defined by the plan | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| trigger | 1..* | TriggerDefinition | When the action should be triggered | |||||
| type | Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. | ||||
| data | Σ | 1..* | DataRequirement | Triggering data of the event (multiple = 'and') | ||||
| type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. Required Pattern: Observation | ||||
| condition | Σ | 1..1 | Expression | Whether the event triggers (boolean expression) | ||||
| language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Required Pattern: application/x.rmd-ace+json | ||||
| expression | Σ | 1..1 | string | Expression in specified language | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| PlanDefinition.type | extensible | Pattern: rule | ||||
| PlanDefinition.status | required | ResMedPlanDefinitionStatusValueSet | ||||
| PlanDefinition.useContext.code | extensible | Pattern: program | ||||
| PlanDefinition.useContext.value[x] | required | ResMedRuleImplementerIdentifierValueSet (a valid code from ResMed Rule Implementer Identifier CodeSystem) | ||||
| PlanDefinition.action.trigger.type | required | TriggerType | ||||
| PlanDefinition.action.trigger.data.type | required | Pattern: Observation | ||||
| PlanDefinition.action.trigger.condition.language | extensible | Pattern: application/x.rmd-ace+json
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
| identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
| version | Σ | 1..1 | string | Business version of the plan definition | ||||
| name | ΣC | 1..1 | string | Name for this plan definition (computer friendly) | ||||
| title | Σ | 0..1 | string | Name for this plan definition (human friendly) | ||||
| subtitle | 0..1 | string | Subordinate title of the plan definition | |||||
| type | Σ | 1..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-plandefinition-type-identifier | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rule | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ResMed PlanDefinition status ValueSet (required) | ||||
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
 subject[x] | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept | CodeableConcept | |||||||
 subjectReference | Reference(Group) | |||||||
| date | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | Σ | 0..1 | markdown | Natural language description of the plan definition | ||||
| useContext | Σ | 1..1 | UsageContext | The context that the content is intended to support | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ResMed Rule Implementer Identifier ValueSet (required) | ||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this plan definition is defined | |||||
| usage | 0..1 | string | Describes the clinical usage of the plan | |||||
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate | 0..1 | date | When the plan definition was approved by publisher | |||||
| lastReviewDate | 0..1 | date | When the plan definition was last reviewed | |||||
| effectivePeriod | Σ | 0..1 | Period | When the plan definition is expected to be used | ||||
| topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author | 0..* | ContactDetail | Who authored the content | |||||
| editor | 0..* | ContactDetail | Who edited the content | |||||
| reviewer | 0..* | ContactDetail | Who reviewed the content | |||||
| endorser | 0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations | |||||
| library | 0..* | canonical(Library) | Logic used by the plan definition | |||||
| goal | 0..* | BackboneElement | What the plan is trying to accomplish | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| category | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
| description | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
| priority | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
| start | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
| addresses | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
| documentation | 0..* | RelatedArtifact | Supporting documentation for the goal | |||||
| target | 0..* | BackboneElement | Target outcome for the goal | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| measure | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |||||
| detail[x] | 0..1 | The target value to be achieved | ||||||
| detailQuantity | Quantity | |||||||
| detailRange | Range | |||||||
| detailCodeableConcept | CodeableConcept | |||||||
| due | 0..1 | Duration | Reach goal within | |||||
| action | 1..* | BackboneElement | Action defined by the plan | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
| title | 0..1 | string | User-visible title | |||||
| description | 0..1 | string | Brief description of the action | |||||
| textEquivalent | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
| priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | |||||
| reason | 0..* | CodeableConcept | Why the action should be performed | |||||
| documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
| goalId | 0..* | id | What goals this action supports | |||||
| subject[x] | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept | CodeableConcept | |||||||
| subjectReference | Reference(Group) | |||||||
| trigger | 1..* | TriggerDefinition | When the action should be triggered | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type | Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. | ||||
| name | Σ | 0..1 | string | Name or URI that identifies the event | ||||
| timing[x] | Σ | 0..1 | Timing of the event | |||||
| timingTiming | Timing | |||||||
| timingReference | Reference(Schedule) | |||||||
| timingDate | date | |||||||
| timingDateTime | dateTime | |||||||
| data | Σ | 1..* | DataRequirement | Triggering data of the event (multiple = 'and') | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. Required Pattern: Observation | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
| subject[x] | Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). | |||||
| subjectCodeableConcept | CodeableConcept | |||||||
| subjectReference | Reference(Group) | |||||||
| mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
| codeFilter | ΣC | 0..* | Element | What codes are expected | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path | Σ | 0..1 | string | A code-valued attribute to filter on | ||||
| searchParam | Σ | 0..1 | string | A coded (token) parameter to search on | ||||
| valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
| code | Σ | 0..* | Coding | What code is expected | ||||
| dateFilter | ΣC | 0..* | Element | What dates/date ranges are expected | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path | Σ | 0..1 | string | A date-valued attribute to filter on | ||||
| searchParam | Σ | 0..1 | string | A date valued parameter to search on | ||||
| value[x] | Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| valueDuration | Duration | |||||||
| limit | Σ | 0..1 | positiveInt | Number of results | ||||
| sort | Σ | 0..* | Element | Order of the results | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path | Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
| direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
| condition | Σ | 1..1 | Expression | Whether the event triggers (boolean expression) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| description | Σ | 0..1 | string | Natural language description of the condition | ||||
| name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
| language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Required Pattern: application/x.rmd-ace+json | ||||
| expression | Σ | 1..1 | string | Expression in specified language | ||||
| reference | Σ | 0..1 | uri | Where the expression is found | ||||
| condition | 0..* | BackboneElement | Whether or not the action is applicable | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |||||
| expression | 0..1 | Expression | Boolean-valued expression | |||||
| input | 0..* | DataRequirement | Input data requirements | |||||
| output | 0..* | DataRequirement | Output data definition | |||||
| relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| actionId | 1..1 | id | What action is this related to | |||||
| relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | |||||
| offset[x] | 0..1 | Time offset for the relationship | ||||||
| offsetDuration | Duration | |||||||
| offsetRange | Range | |||||||
| timing[x] | 0..1 | When the action should take place | ||||||
| timingDateTime | dateTime | |||||||
| timingAge | Age | |||||||
| timingPeriod | Period | |||||||
| timingDuration | Duration | |||||||
| timingRange | Range | |||||||
| timingTiming | Timing | |||||||
| participant | 0..* | BackboneElement | Who should participate in the action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
| role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
| type | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
| groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
| selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
| requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
| precheckBehavior | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
| cardinalityBehavior | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
| definition[x] | 0..1 | Description of the activity to be performed | ||||||
| definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
| definitionUri | uri | |||||||
| transform | 0..1 | canonical(StructureMap) | Transform to apply the template | |||||
| dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| path | 0..1 | string | The path to the element to be set dynamically | |||||
| expression | 0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
| action | 0..* | See action (PlanDefinition) | A sub-action | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| PlanDefinition.language | preferred | CommonLanguages
| ||||
| PlanDefinition.type | extensible | Pattern: rule | ||||
| PlanDefinition.status | required | ResMedPlanDefinitionStatusValueSet | ||||
| PlanDefinition.subject[x] | extensible | SubjectType | ||||
| PlanDefinition.useContext.code | extensible | Pattern: program | ||||
| PlanDefinition.useContext.value[x] | required | ResMedRuleImplementerIdentifierValueSet (a valid code from ResMed Rule Implementer Identifier CodeSystem) | ||||
| PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| PlanDefinition.topic | example | DefinitionTopic | ||||
| PlanDefinition.goal.category | example | GoalCategory | ||||
| PlanDefinition.goal.description | example | SNOMEDCTClinicalFindings | ||||
| PlanDefinition.goal.priority | preferred | GoalPriority | ||||
| PlanDefinition.goal.start | example | GoalStartEvent | ||||
| PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodes | ||||
| PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC) | ||||
| PlanDefinition.action.priority | required | RequestPriority | ||||
| PlanDefinition.action.subject[x] | extensible | SubjectType | ||||
| PlanDefinition.action.trigger.type | required | TriggerType | ||||
| PlanDefinition.action.trigger.data.type | required | Pattern: Observation | ||||
| PlanDefinition.action.trigger.data.subject[x] | extensible | SubjectType | ||||
| PlanDefinition.action.trigger.data.sort.direction | required | SortDirection | ||||
| PlanDefinition.action.trigger.condition.language | extensible | Pattern: application/x.rmd-ace+json
| ||||
| PlanDefinition.action.condition.kind | required | ActionConditionKind | ||||
| PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipType | ||||
| PlanDefinition.action.participant.type | required | ActionParticipantType | ||||
| PlanDefinition.action.participant.role | example | ActionParticipantRole | ||||
| PlanDefinition.action.type | extensible | ActionType | ||||
| PlanDefinition.action.groupingBehavior | required | ActionGroupingBehavior | ||||
| PlanDefinition.action.selectionBehavior | required | ActionSelectionBehavior | ||||
| PlanDefinition.action.requiredBehavior | required | ActionRequiredBehavior | ||||
| PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehavior | ||||
| PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehavior |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
| drq-1 | error | PlanDefinition.action.trigger.data.codeFilter | Either a path or a searchParam must be provided, but not both : path.exists() xor searchParam.exists() | |
| drq-2 | error | PlanDefinition.action.trigger.data.dateFilter | Either a path or a searchParam must be provided, but not both : path.exists() xor searchParam.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
This structure is derived from PlanDefinition
Differential View
This structure is derived from PlanDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PlanDefinition | PlanDefinition | |||
| version | 1..1 | string | Business version of the plan definition | |
| name | 1..1 | string | Name for this plan definition (computer friendly) | |
| type | 1..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-plandefinition-type-identifier | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rule | |
| status | 1..1 | code | draft | active | retired | unknown Binding: ResMed PlanDefinition status ValueSet (required) | |
| useContext | 1..1 | UsageContext | The context that the content is intended to support | |
| code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
| value[x] | 1..1 | CodeableConcept | Value that defines the context Binding: ResMed Rule Implementer Identifier ValueSet (required) | |
| action | 1..* | BackboneElement | Action defined by the plan | |
| trigger | 1..* | TriggerDefinition | When the action should be triggered | |
| data | 1..* | DataRequirement | Triggering data of the event (multiple = 'and') | |
| type | 1..1 | code | The type of the required data Required Pattern: Observation | |
| condition | 1..1 | Expression | Whether the event triggers (boolean expression) | |
| language | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Required Pattern: application/x.rmd-ace+json | |
| expression | 1..1 | string | Expression in specified language | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| PlanDefinition.status | required | ResMedPlanDefinitionStatusValueSet |
| PlanDefinition.useContext.value[x] | required | ResMedRuleImplementerIdentifierValueSet (a valid code from ResMed Rule Implementer Identifier CodeSystem) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| version | Σ | 1..1 | string | Business version of the plan definition | ||||
| name | ΣC | 1..1 | string | Name for this plan definition (computer friendly) | ||||
| type | Σ | 1..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following | ||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-plandefinition-type-identifier | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rule | |||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ResMed PlanDefinition status ValueSet (required) | ||||
| useContext | Σ | 1..1 | UsageContext | The context that the content is intended to support | ||||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following | ||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |||||
| value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ResMed Rule Implementer Identifier ValueSet (required) | ||||
| action | 1..* | BackboneElement | Action defined by the plan | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| trigger | 1..* | TriggerDefinition | When the action should be triggered | |||||
| type | Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. | ||||
| data | Σ | 1..* | DataRequirement | Triggering data of the event (multiple = 'and') | ||||
| type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. Required Pattern: Observation | ||||
| condition | Σ | 1..1 | Expression | Whether the event triggers (boolean expression) | ||||
| language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Required Pattern: application/x.rmd-ace+json | ||||
| expression | Σ | 1..1 | string | Expression in specified language | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| PlanDefinition.type | extensible | Pattern: rule | ||||
| PlanDefinition.status | required | ResMedPlanDefinitionStatusValueSet | ||||
| PlanDefinition.useContext.code | extensible | Pattern: program | ||||
| PlanDefinition.useContext.value[x] | required | ResMedRuleImplementerIdentifierValueSet (a valid code from ResMed Rule Implementer Identifier CodeSystem) | ||||
| PlanDefinition.action.trigger.type | required | TriggerType | ||||
| PlanDefinition.action.trigger.data.type | required | Pattern: Observation | ||||
| PlanDefinition.action.trigger.condition.language | extensible | Pattern: application/x.rmd-ace+json
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
| identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
| version | Σ | 1..1 | string | Business version of the plan definition | ||||
| name | ΣC | 1..1 | string | Name for this plan definition (computer friendly) | ||||
| title | Σ | 0..1 | string | Name for this plan definition (human friendly) | ||||
| subtitle | 0..1 | string | Subordinate title of the plan definition | |||||
| type | Σ | 1..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.resmed.com/CodeSystem/resmed-plandefinition-type-identifier | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rule | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ResMed PlanDefinition status ValueSet (required) | ||||
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subject[x] | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept | CodeableConcept | |||||||
| subjectReference | Reference(Group) | |||||||
| date | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | Σ | 0..1 | markdown | Natural language description of the plan definition | ||||
| useContext | Σ | 1..1 | UsageContext | The context that the content is intended to support | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| value[x] | Σ | 1..1 | CodeableConcept | Value that defines the context Binding: ResMed Rule Implementer Identifier ValueSet (required) | ||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this plan definition is defined | |||||
| usage | 0..1 | string | Describes the clinical usage of the plan | |||||
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate | 0..1 | date | When the plan definition was approved by publisher | |||||
| lastReviewDate | 0..1 | date | When the plan definition was last reviewed | |||||
| effectivePeriod | Σ | 0..1 | Period | When the plan definition is expected to be used | ||||
| topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author | 0..* | ContactDetail | Who authored the content | |||||
| editor | 0..* | ContactDetail | Who edited the content | |||||
| reviewer | 0..* | ContactDetail | Who reviewed the content | |||||
| endorser | 0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations | |||||
| library | 0..* | canonical(Library) | Logic used by the plan definition | |||||
| goal | 0..* | BackboneElement | What the plan is trying to accomplish | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| category | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
| description | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
| priority | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
| start | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
| addresses | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
| documentation | 0..* | RelatedArtifact | Supporting documentation for the goal | |||||
| target | 0..* | BackboneElement | Target outcome for the goal | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| measure | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |||||
| detail[x] | 0..1 | The target value to be achieved | ||||||
| detailQuantity | Quantity | |||||||
| detailRange | Range | |||||||
| detailCodeableConcept | CodeableConcept | |||||||
| due | 0..1 | Duration | Reach goal within | |||||
| action | 1..* | BackboneElement | Action defined by the plan | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
| title | 0..1 | string | User-visible title | |||||
| description | 0..1 | string | Brief description of the action | |||||
| textEquivalent | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
| priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | |||||
| reason | 0..* | CodeableConcept | Why the action should be performed | |||||
| documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
| goalId | 0..* | id | What goals this action supports | |||||
| subject[x] | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept | CodeableConcept | |||||||
| subjectReference | Reference(Group) | |||||||
| trigger | 1..* | TriggerDefinition | When the action should be triggered | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type | Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. | ||||
| name | Σ | 0..1 | string | Name or URI that identifies the event | ||||
| timing[x] | Σ | 0..1 | Timing of the event | |||||
| timingTiming | Timing | |||||||
| timingReference | Reference(Schedule) | |||||||
| timingDate | date | |||||||
| timingDateTime | dateTime | |||||||
| data | Σ | 1..* | DataRequirement | Triggering data of the event (multiple = 'and') | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. Required Pattern: Observation | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
| subject[x] | Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). | |||||
| subjectCodeableConcept | CodeableConcept | |||||||
| subjectReference | Reference(Group) | |||||||
| mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
| codeFilter | ΣC | 0..* | Element | What codes are expected | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path | Σ | 0..1 | string | A code-valued attribute to filter on | ||||
| searchParam | Σ | 0..1 | string | A coded (token) parameter to search on | ||||
| valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
| code | Σ | 0..* | Coding | What code is expected | ||||
| dateFilter | ΣC | 0..* | Element | What dates/date ranges are expected | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path | Σ | 0..1 | string | A date-valued attribute to filter on | ||||
| searchParam | Σ | 0..1 | string | A date valued parameter to search on | ||||
| value[x] | Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| valueDuration | Duration | |||||||
| limit | Σ | 0..1 | positiveInt | Number of results | ||||
| sort | Σ | 0..* | Element | Order of the results | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path | Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
| direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
| condition | Σ | 1..1 | Expression | Whether the event triggers (boolean expression) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| description | Σ | 0..1 | string | Natural language description of the condition | ||||
| name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
| language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Required Pattern: application/x.rmd-ace+json | ||||
| expression | Σ | 1..1 | string | Expression in specified language | ||||
| reference | Σ | 0..1 | uri | Where the expression is found | ||||
| condition | 0..* | BackboneElement | Whether or not the action is applicable | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |||||
| expression | 0..1 | Expression | Boolean-valued expression | |||||
| input | 0..* | DataRequirement | Input data requirements | |||||
| output | 0..* | DataRequirement | Output data definition | |||||
| relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| actionId | 1..1 | id | What action is this related to | |||||
| relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | |||||
| offset[x] | 0..1 | Time offset for the relationship | ||||||
| offsetDuration | Duration | |||||||
| offsetRange | Range | |||||||
| timing[x] | 0..1 | When the action should take place | ||||||
| timingDateTime | dateTime | |||||||
| timingAge | Age | |||||||
| timingPeriod | Period | |||||||
| timingDuration | Duration | |||||||
| timingRange | Range | |||||||
| timingTiming | Timing | |||||||
| participant | 0..* | BackboneElement | Who should participate in the action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
| role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
| type | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
| groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
| selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
| requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
| precheckBehavior | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
| cardinalityBehavior | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
| definition[x] | 0..1 | Description of the activity to be performed | ||||||
| definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
| definitionUri | uri | |||||||
| transform | 0..1 | canonical(StructureMap) | Transform to apply the template | |||||
| dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| path | 0..1 | string | The path to the element to be set dynamically | |||||
| expression | 0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
| action | 0..* | See action (PlanDefinition) | A sub-action | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| PlanDefinition.language | preferred | CommonLanguages
| ||||
| PlanDefinition.type | extensible | Pattern: rule | ||||
| PlanDefinition.status | required | ResMedPlanDefinitionStatusValueSet | ||||
| PlanDefinition.subject[x] | extensible | SubjectType | ||||
| PlanDefinition.useContext.code | extensible | Pattern: program | ||||
| PlanDefinition.useContext.value[x] | required | ResMedRuleImplementerIdentifierValueSet (a valid code from ResMed Rule Implementer Identifier CodeSystem) | ||||
| PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| PlanDefinition.topic | example | DefinitionTopic | ||||
| PlanDefinition.goal.category | example | GoalCategory | ||||
| PlanDefinition.goal.description | example | SNOMEDCTClinicalFindings | ||||
| PlanDefinition.goal.priority | preferred | GoalPriority | ||||
| PlanDefinition.goal.start | example | GoalStartEvent | ||||
| PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodes | ||||
| PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC) | ||||
| PlanDefinition.action.priority | required | RequestPriority | ||||
| PlanDefinition.action.subject[x] | extensible | SubjectType | ||||
| PlanDefinition.action.trigger.type | required | TriggerType | ||||
| PlanDefinition.action.trigger.data.type | required | Pattern: Observation | ||||
| PlanDefinition.action.trigger.data.subject[x] | extensible | SubjectType | ||||
| PlanDefinition.action.trigger.data.sort.direction | required | SortDirection | ||||
| PlanDefinition.action.trigger.condition.language | extensible | Pattern: application/x.rmd-ace+json
| ||||
| PlanDefinition.action.condition.kind | required | ActionConditionKind | ||||
| PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipType | ||||
| PlanDefinition.action.participant.type | required | ActionParticipantType | ||||
| PlanDefinition.action.participant.role | example | ActionParticipantRole | ||||
| PlanDefinition.action.type | extensible | ActionType | ||||
| PlanDefinition.action.groupingBehavior | required | ActionGroupingBehavior | ||||
| PlanDefinition.action.selectionBehavior | required | ActionSelectionBehavior | ||||
| PlanDefinition.action.requiredBehavior | required | ActionRequiredBehavior | ||||
| PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehavior | ||||
| PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehavior |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
| drq-1 | error | PlanDefinition.action.trigger.data.codeFilter | Either a path or a searchParam must be provided, but not both : path.exists() xor searchParam.exists() | |
| drq-2 | error | PlanDefinition.action.trigger.data.dateFilter | Either a path or a searchParam must be provided, but not both : path.exists() xor searchParam.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
This structure is derived from PlanDefinition
Other representations of profile: CSV, Excel, Schematron