ID

40180

Description

https://www.hl7.org/fhir/resourcelist.html (accessed at 27.01.2020) This form contains an incomplete implementation of the FHIR Resource Plan Definition(2). After preliminary review, it contains the data elements that request clinical information.

Link

https://www.hl7.org/fhir/resourcelist.html

Keywords

Versions (2)
  1. 2/24/20 2/24/20 -
  2. 3/18/20 3/18/20 -
Copyright Holder

HL7 FHIR

Uploaded on

March 18, 2020

DOI

To request one please log in.

License

Creative Commons BY-NC 4.0
Model comments :

You can comment on the data model here. Via the speech bubbles at the itemgroups and items you can add comments to those specificially.

Back to model comments
Itemgroup comments for :

Item comments for :

In order to download data models you must be logged in. Please log in or register for free.

FHIR v4.0.1

English

Resource Plan Definition (2)

1 forms  
PlanDefinition
Description

PlanDefinition

Alias
UMLS CUI-1
C1704788
UMLS CUI-2
C3484370
PlanDefinition.title
Description

PlanDefinition.title

Data type

text

Alias
UMLS CUI [1,1]
C1704788
UMLS CUI [1,2]
C3484370
UMLS CUI [1,3]
C3888414
PlanDefinition.subtitle
Description

An explanatory or alternate title for the plan definition giving additional information about its content.

Data type

text

Alias
UMLS CUI [1,1]
C1704788
UMLS CUI [1,2]
C3484370
UMLS CUI [1,3]
C3888414
UMLS CUI [1,4]
C1546922
UMLS CUI [1,5]
C0681841
UMLS CUI [2,1]
C1704788
UMLS CUI [2,2]
C3484370
UMLS CUI [2,3]
C3888414
UMLS CUI [2,4]
C1546922
UMLS CUI [2,5]
C1523987
PlanDefinition.type
Description

A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

Data type

text

Alias
UMLS CUI [1,1]
C1704788
UMLS CUI [1,2]
C3484370
UMLS CUI [1,3]
C0332307
PlanDefinition.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. Allows filtering of plan definitions that are appropriate for use versus not.

Data type

boolean

Alias
UMLS CUI [1,1]
C1704788
UMLS CUI [1,2]
C3484370
UMLS CUI [1,3]
C1555472
UMLS CUI [1,4]
C1517586
PlanDefinition.subject[x]
Description

A code or group definition that describes the intended subject of the plan definition.

Data type

text

Alias
UMLS CUI [1,1]
C1704788
UMLS CUI [1,2]
C3484370
UMLS CUI [1,3]
C1283828
UMLS CUI [1,4]
C1550501
PlanDefinition.description
Description

A free text natural language description of the plan definition from a consumer's perspective. This description can be used to capture details such as why the plan definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).

Data type

text

Alias
UMLS CUI [1,1]
C1704788
UMLS CUI [1,2]
C3484370
UMLS CUI [1,3]
C0678257
PlanDefinition.usage
Description

PlanDefinition.usage

Data type

text

Alias
UMLS CUI [1,1]
C1704788
UMLS CUI [1,2]
C3484370
UMLS CUI [1,3]
C0678257
UMLS CUI [1,4]
C0457083
UMLS CUI [1,5]
C0205210
PlanDefinition.relatedArtifact
Description

Related artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another resource, but not both.

Data type

text

Alias
UMLS CUI [1,1]
C1546922
UMLS CUI [1,2]
C0439849
PlanDefinition.goal.category
Description

PlanDefinition.goal.category

Data type

text

Alias
UMLS CUI [1,1]
C0018017
UMLS CUI [1,2]
C0683312
PlanDefinition.goal.description
Description

PlanDefinition.goal.description

Data type

text

Alias
UMLS CUI [1,1]
C0018017
UMLS CUI [1,2]
C0678257
PlanDefinition.goal.priority
Description

PlanDefinition.goal.priority

Data type

text

Alias
UMLS CUI [1,1]
C0018017
UMLS CUI [1,2]
C0549179
PlanDefinition.goal.start
Description

The event after which the goal should begin being pursued.

Data type

text

Alias
UMLS CUI [1,1]
C0018017
UMLS CUI [1,2]
C0439659
PlanDefinition.goal.addresses
Description

Identifies problems, conditions, issues, or concerns the goal is intended to address.

Data type

text

Alias
UMLS CUI [1,1]
C0018017
UMLS CUI [1,2]
C4048755
UMLS CUI [1,3]
C0033213
UMLS CUI [2,1]
C0018017
UMLS CUI [2,2]
C4048755
UMLS CUI [2,3]
C0348080
PlanDefinition.goal.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.

Data type

text

Alias
UMLS CUI [1,1]
C0018017
UMLS CUI [1,2]
C0920316
PlanDefinition.goal.target.measure
Description

The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

Data type

text

Alias
UMLS CUI [1,1]
C0018017
UMLS CUI [1,2]
C1521840
UMLS CUI [1,3]
C0242485
UMLS CUI [2,1]
C0018017
UMLS CUI [2,2]
C1521840
UMLS CUI [2,3]
C0449381
PlanDefinition.goal.target.detail[x]
Description

The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0 percent. 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.

Data type

text

Alias
UMLS CUI [1,1]
C1272277
UMLS CUI [1,2]
C1521840
UMLS CUI [1,3]
C0243095
UMLS CUI [1,4]
C0079809
UMLS CUI [1,5]
C1274040
PlanDefinition.goal.target.due
Description

Indicates the timeframe after the start of the goal in which the goal should be met.

Data type

text

Alias
UMLS CUI [1,1]
C0018017
UMLS CUI [1,2]
C1521840
UMLS CUI [1,3]
C3146286
UMLS CUI [1,4]
C0872291
PlanDefinition.action.title
Description

PlanDefinition.action.title

Data type

text

Alias
UMLS CUI [1,1]
C3266814
UMLS CUI [1,2]
C3888414
PlanDefinition.action.description
Description

PlanDefinition.action.description

Data type

text

Alias
UMLS CUI [1,1]
C3266814
UMLS CUI [1,2]
C0678257
PlanDefinition.action.priority
Description

PlanDefinition.action.priority

Data type

text

Alias
UMLS CUI [1,1]
C3266814
UMLS CUI [1,2]
C0549179
PlanDefinition.action.code
Description

PlanDefinition.action.code

Data type

text

Alias
UMLS CUI [1,1]
C3266814
UMLS CUI [1,2]
C0805701
PlanDefinition.action.reason
Description

PlanDefinition.action.reason

Data type

text

Alias
UMLS CUI [1,1]
C3266814
UMLS CUI [1,2]
C0392360
PlanDefinition.action.subject[x]
Description

A code or group definition that describes the intended subject of the action and its children, if any. The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified. In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Data type

text

Alias
UMLS CUI [1,1]
C3266814
UMLS CUI [1,2]
C1283828
UMLS CUI [1,3]
C1550501
UMLS CUI [1,4]
C0805701
UMLS CUI [2,1]
C3266814
UMLS CUI [2,2]
C1283828
UMLS CUI [2,3]
C1550501
UMLS CUI [2,4]
C1704788
PlanDefinition.action.trigger
Description

A description of when the action should be triggered.

Data type

text

Alias
UMLS CUI [1,1]
C3266814
UMLS CUI [1,2]
C0032930
PlanDefinition.action.condition.kind
Description

PlanDefinition.action.condition.kind

Data type

text

Alias
UMLS CUI [1,1]
C0348080
UMLS CUI [1,2]
C0332307
PlanDefinition.action.relatedAction.relationship
Description

PlanDefinition.action.relatedAction.relationship

Data type

text

Alias
UMLS CUI [1,1]
C3266814
UMLS CUI [1,2]
C0439849
UMLS CUI [1,3]
C0332281
UMLS CUI [1,4]
C0205394
PlanDefinition.action.relatedAction.offset[x]
Description

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

Data type

text

Alias
UMLS CUI [1,1]
C3266814
UMLS CUI [1,2]
C0332281
UMLS CUI [1,3]
C0205394
UMLS CUI [1,4]
C1711330
UMLS CUI [2,1]
C3266814
UMLS CUI [2,2]
C0332281
UMLS CUI [2,3]
C0205394
UMLS CUI [2,4]
C0449238
UMLS CUI [3,1]
C3266814
UMLS CUI [3,2]
C0332281
UMLS CUI [3,3]
C0205394
UMLS CUI [3,4]
C0449238
UMLS CUI [3,5]
C1514721
PlanDefinition.action.timing[x]
Description

PlanDefinition.action.timing[x]

Data type

text

Alias
UMLS CUI [1,1]
C3266814
UMLS CUI [1,2]
C0449243
UMLS CUI [2,1]
C3266814
UMLS CUI [2,2]
C1301880
PlanDefinition.action.participant.type
Description

PlanDefinition.action.participant.type

Data type

text

Alias
UMLS CUI [1,1]
C3266814
UMLS CUI [1,2]
C0679646
UMLS CUI [1,3]
C0332307
PlanDefinition.action.participant.role
Description

PlanDefinition.action.participant.role

Data type

text

Alias
UMLS CUI [1,1]
C3266814
UMLS CUI [1,2]
C0679646
UMLS CUI [1,3]
C1705810
Back to the top of the page

Similar models

Resource Plan Definition (2)

1 forms
Name
Type
Description | Question | Decode (Coded Value)
Data type
Alias
Item Group
PlanDefinition
C1704788 (UMLS CUI-1)
C3484370 (UMLS CUI-2)
PlanDefinition.title
Item
PlanDefinition.title
text
C1704788 (UMLS CUI [1,1])
C3484370 (UMLS CUI [1,2])
C3888414 (UMLS CUI [1,3])
PlanDefinition.subtitle
Item
PlanDefinition.subtitle
text
C1704788 (UMLS CUI [1,1])
C3484370 (UMLS CUI [1,2])
C3888414 (UMLS CUI [1,3])
C1546922 (UMLS CUI [1,4])
C0681841 (UMLS CUI [1,5])
C1704788 (UMLS CUI [2,1])
C3484370 (UMLS CUI [2,2])
C3888414 (UMLS CUI [2,3])
C1546922 (UMLS CUI [2,4])
C1523987 (UMLS CUI [2,5])
PlanDefinition.type
Item
PlanDefinition.type
text
C1704788 (UMLS CUI [1,1])
C3484370 (UMLS CUI [1,2])
C0332307 (UMLS CUI [1,3])
PlanDefinition.experimental
Item
PlanDefinition.experimental
boolean
C1704788 (UMLS CUI [1,1])
C3484370 (UMLS CUI [1,2])
C1555472 (UMLS CUI [1,3])
C1517586 (UMLS CUI [1,4])
PlanDefinition.subject[x]
Item
PlanDefinition.subject[x]
text
C1704788 (UMLS CUI [1,1])
C3484370 (UMLS CUI [1,2])
C1283828 (UMLS CUI [1,3])
C1550501 (UMLS CUI [1,4])
PlanDefinition.description
Item
PlanDefinition.description
text
C1704788 (UMLS CUI [1,1])
C3484370 (UMLS CUI [1,2])
C0678257 (UMLS CUI [1,3])
PlanDefinition.usage
Item
PlanDefinition.usage
text
C1704788 (UMLS CUI [1,1])
C3484370 (UMLS CUI [1,2])
C0678257 (UMLS CUI [1,3])
C0457083 (UMLS CUI [1,4])
C0205210 (UMLS CUI [1,5])
PlanDefinition.relatedArtifact
Item
PlanDefinition.relatedArtifact
text
C1546922 (UMLS CUI [1,1])
C0439849 (UMLS CUI [1,2])
PlanDefinition.goal.category
Item
PlanDefinition.goal.category
text
C0018017 (UMLS CUI [1,1])
C0683312 (UMLS CUI [1,2])
PlanDefinition.goal.description
Item
PlanDefinition.goal.description
text
C0018017 (UMLS CUI [1,1])
C0678257 (UMLS CUI [1,2])
PlanDefinition.goal.priority
Item
PlanDefinition.goal.priority
text
C0018017 (UMLS CUI [1,1])
C0549179 (UMLS CUI [1,2])
PlanDefinition.goal.start
Item
PlanDefinition.goal.start
text
C0018017 (UMLS CUI [1,1])
C0439659 (UMLS CUI [1,2])
PlanDefinition.goal.addresses
Item
PlanDefinition.goal.addresses
text
C0018017 (UMLS CUI [1,1])
C4048755 (UMLS CUI [1,2])
C0033213 (UMLS CUI [1,3])
C0018017 (UMLS CUI [2,1])
C4048755 (UMLS CUI [2,2])
C0348080 (UMLS CUI [2,3])
PlanDefinition.goal.documentation
Item
PlanDefinition.goal.documentation
text
C0018017 (UMLS CUI [1,1])
C0920316 (UMLS CUI [1,2])
PlanDefinition.goal.target.measure
Item
PlanDefinition.goal.target.measure
text
C0018017 (UMLS CUI [1,1])
C1521840 (UMLS CUI [1,2])
C0242485 (UMLS CUI [1,3])
C0018017 (UMLS CUI [2,1])
C1521840 (UMLS CUI [2,2])
C0449381 (UMLS CUI [2,3])
PlanDefinition.goal.target.detail[x]
Item
PlanDefinition.goal.target.detail[x]
text
C1272277 (UMLS CUI [1,1])
C1521840 (UMLS CUI [1,2])
C0243095 (UMLS CUI [1,3])
C0079809 (UMLS CUI [1,4])
C1274040 (UMLS CUI [1,5])
PlanDefinition.goal.target.due
Item
PlanDefinition.goal.target.due
text
C0018017 (UMLS CUI [1,1])
C1521840 (UMLS CUI [1,2])
C3146286 (UMLS CUI [1,3])
C0872291 (UMLS CUI [1,4])
PlanDefinition.action.title
Item
PlanDefinition.action.title
text
C3266814 (UMLS CUI [1,1])
C3888414 (UMLS CUI [1,2])
PlanDefinition.action.description
Item
PlanDefinition.action.description
text
C3266814 (UMLS CUI [1,1])
C0678257 (UMLS CUI [1,2])
PlanDefinition.action.priority
Item
PlanDefinition.action.priority
text
C3266814 (UMLS CUI [1,1])
C0549179 (UMLS CUI [1,2])
PlanDefinition.action.code
Item
PlanDefinition.action.code
text
C3266814 (UMLS CUI [1,1])
C0805701 (UMLS CUI [1,2])
PlanDefinition.action.reason
Item
PlanDefinition.action.reason
text
C3266814 (UMLS CUI [1,1])
C0392360 (UMLS CUI [1,2])
PlanDefinition.action.subject[x]
Item
PlanDefinition.action.subject[x]
text
C3266814 (UMLS CUI [1,1])
C1283828 (UMLS CUI [1,2])
C1550501 (UMLS CUI [1,3])
C0805701 (UMLS CUI [1,4])
C3266814 (UMLS CUI [2,1])
C1283828 (UMLS CUI [2,2])
C1550501 (UMLS CUI [2,3])
C1704788 (UMLS CUI [2,4])
PlanDefinition.action.trigger
Item
PlanDefinition.action.trigger
text
C3266814 (UMLS CUI [1,1])
C0032930 (UMLS CUI [1,2])
PlanDefinition.action.condition.kind
Item
PlanDefinition.action.condition.kind
text
C0348080 (UMLS CUI [1,1])
C0332307 (UMLS CUI [1,2])
PlanDefinition.action.relatedAction.relationship
Item
PlanDefinition.action.relatedAction.relationship
text
C3266814 (UMLS CUI [1,1])
C0439849 (UMLS CUI [1,2])
C0332281 (UMLS CUI [1,3])
C0205394 (UMLS CUI [1,4])
PlanDefinition.action.relatedAction.offset[x]
Item
PlanDefinition.action.relatedAction.offset[x]
text
C3266814 (UMLS CUI [1,1])
C0332281 (UMLS CUI [1,2])
C0205394 (UMLS CUI [1,3])
C1711330 (UMLS CUI [1,4])
C3266814 (UMLS CUI [2,1])
C0332281 (UMLS CUI [2,2])
C0205394 (UMLS CUI [2,3])
C0449238 (UMLS CUI [2,4])
C3266814 (UMLS CUI [3,1])
C0332281 (UMLS CUI [3,2])
C0205394 (UMLS CUI [3,3])
C0449238 (UMLS CUI [3,4])
C1514721 (UMLS CUI [3,5])
PlanDefinition.action.timing[x]
Item
PlanDefinition.action.timing[x]
text
C3266814 (UMLS CUI [1,1])
C0449243 (UMLS CUI [1,2])
C3266814 (UMLS CUI [2,1])
C1301880 (UMLS CUI [2,2])
PlanDefinition.action.participant.type
Item
PlanDefinition.action.participant.type
text
C3266814 (UMLS CUI [1,1])
C0679646 (UMLS CUI [1,2])
C0332307 (UMLS CUI [1,3])
PlanDefinition.action.participant.role
Item
PlanDefinition.action.participant.role
text
C3266814 (UMLS CUI [1,1])
C0679646 (UMLS CUI [1,2])
C1705810 (UMLS CUI [1,3])
Back to the top of the page 

Contact

Please use this form for feedback, questions and suggestions for improvements.

Fields marked with * are required.

Help

Do you need help on how to use the search function? Please watch the corresponding tutorial video for more details and learn how to use the search function most efficiently.

Watch Tutorial