Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) 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 R3 R2

Content Examples Detailed Descriptions Mappings Profiles & Extensions Operations R3 Conversions 2.39.12 Resource List - Detailed Descriptions

Example EvidenceVariable/example-no-alteplase (Turtle)

FHIR Infrastructure Clinical Decision Support Work Group Maturity Level : 1   Trial Use N/A Security Category Standards Status : Not Classified Informative Compartments : Device , Patient , Practitioner Not linked to any defined compartments
Detailed Descriptions for the elements in the List resource. List Element Id List Definition A list is a curated collection of resources. Cardinality 0..* Type DomainResource Alternate Names Collection; WorkingList; Organizer Invariants Defined on this element lst-1 Rule A list can only have an emptyReason if it is empty emptyReason.empty() or entry.empty() lst-2 Rule The deleted flag can only be used if the mode of the list is "changes" mode = 'changes' or entry.deleted.empty() lst-3 Rule An entry date can only be used if the mode of the list is "working" mode = 'working' or entry.date.empty() List.identifier Element Id List.identifier Definition Identifier for the List assigned for business purposes outside the context of FHIR. Note This is a business identifier, not a resource identifier (see discussion ) Cardinality 0..* Type Identifier List.status Element Id List.status Definition Indicates the current state of this list. Cardinality 1..1 Terminology Binding ListStatus ( Required ) Type code Is Modifier true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) Summary true Comments This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. List.mode Element Id List.mode Definition How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. Cardinality 1..1 Terminology Binding ListMode ( Required ) Type code Is Modifier true (Reason: If set to "changes", the list is considered incomplete, while the other two codes indicate the list is complete, which changes the understanding of the elements listed) Requirements Lists are used in various ways, and it must be known in what way it is safe to use them. Summary true Comments This element is labeled as a modifier because a change list must not be misunderstood as a complete list. List.title Element Id List.title Definition A label for the list assigned by the author. Cardinality 0..1 Type string Requirements Allows customization beyond just the code identifying the kind of list. Summary true List.code Element Id List.code Definition This code defines the purpose of the list - why it was created. Cardinality 0..1 Terminology Binding Example Use Codes for List ( Example ) Type CodeableConcept Requirements Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included. Summary true Comments If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code. List.subject Element Id List.subject Definition The common subject (or patient) of the resources that are in the list if there is one. Cardinality 0..1
  • Type Narrative
  • Reference ( Patient | Group | Device | Location XML ) Requirements The primary purpose of listing the subject explicitly is to help with finding the right list.
  • Summary JSON true Comments Some purely arbitrary lists do not have a common subject, so this is optional.
  • TTL List.encounter Element Id List.encounter Definition

The encounter that is the context in which this list was created. Cardinality 0..1 Type Reference Raw Turtle ( Encounter (+ also see Turtle/RDF Format Specification ) List.date Element Id List.date Definition The date that the list was prepared. Cardinality 0..1 Type dateTime Requirements Identifies how current the list is which affects relevance.

Summary true Comments The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs. List.source Element Id List.source Definition The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. Cardinality 0..1 Type Reference ( Practitioner | PractitionerRole | Patient | Device ) Requirements

Allows follow-up as well as context. No Alteplase

Alternate Names Author Summary true Comments 
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

[a fhir:EvidenceVariable;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "example-no-alteplase"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>\n        &quot;No alteplase&quot; is an intended exposure concept that may be used in expressing what an Evidence is about.\n      </p>\n	</div>"
  ];
  fhir:EvidenceVariable.title [ fhir:value "no alteplase"];
  fhir:EvidenceVariable.status [ fhir:value "draft"];
  fhir:EvidenceVariable.actual [ fhir:value "false"^^xsd:boolean];
  fhir:EvidenceVariable.characteristic [
     fhir:index 0;
     fhir:EvidenceVariable.characteristic.description [ fhir:value "no alteplase" ];
     fhir:EvidenceVariable.characteristic.exclude [ fhir:value "true"^^xsd:boolean ];
     fhir:EvidenceVariable.characteristic.definitionCodeableConcept [
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://www.nlm.nih.gov/research/umls/rxnorm" ];
         fhir:Coding.code [ fhir:value "8410" ];
         fhir:Coding.display [ fhir:value "alteplase" ]
       ]
     ]
  ]] .

# - ontology header ------------------------------------------------------------

[a owl:Ontology;
  owl:imports fhir:fhir.ttl] .

# -------------------------------------------------------------------------------------

The primary source is the entity that Usage note: every effort has been made the decisions what items are in the list. This may be software or user. List.orderedBy Element Id List.orderedBy Definition What order applies to the items in the list. Cardinality 0..1 Terminology Binding List Order Codes ( Preferred ) Type CodeableConcept Requirements Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. Comments Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. List.note Element Id List.note Definition Comments ensure that apply to the overall list. Cardinality 0..* Type Annotation List.entry Element Id List.entry Definition Entries in this list. Cardinality 0..* Comments If there examples are no entries in the list, an emptyReason SHOULD be provided. Invariants Affect this element lst-1 Rule A list can only have an emptyReason if it is empty emptyReason.empty() or entry.empty() List.entry.flag Element Id List.entry.flag Definition The flag allows the system constructing the list to indicate the role correct and significance of the item in the list. Cardinality 0..1 Terminology Binding Patient Medicine Change Types ( Example ) Type CodeableConcept Requirements This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list. Comments The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is "changes". List.entry.deleted Element Id List.entry.deleted Definition True if this item is marked as deleted in the list. Cardinality 0..1 Type boolean Is Modifier true (Reason: If deleted is true, then the item included in the list isn't actually part of the list anymore) Meaning if Missing List items useful, but they are generally only treated as deleted when this element explicitly carries a value of true. Systems SHOULD always populate this value when mode is 'changes' Requirements The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as "deleted". Comments If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is "changes". A deleted entry should be displayed in narrative as deleted. This element is labeled as a modifier because it indicates that an item is (to be) no longer in the list. Invariants Affect this element lst-2 Rule The deleted flag can only be used if the mode of the list is "changes" mode = 'changes' or entry.deleted.empty() List.entry.date Element Id List.entry.date Definition When this item was added to the list. Cardinality 0..1 Type dateTime Requirements The date may be significant for understanding the meaning normative part of items in a working list. List.entry.item Element Id List.entry.item Definition A reference to the actual resource from which data was derived. Cardinality 1..1 Type Reference ( Any ) List.emptyReason Element Id List.emptyReason Definition If the list is empty, why the list is empty. Cardinality 0..1 Terminology Binding List Empty Reasons ( Preferred ) Type CodeableConcept Requirements Allows capturing things like "none exist" or "not asked" which can be important for most lists. Comments The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. specification.

Invariants Affect this element lst-1 Rule A list can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()