- FHIR List Resource
- Electronic Health Records Exchange Through FHIR
- Medical Terminology
- Processes Data
- Processes Information
- Processes Documentation
- Health Information Exchange
- Electronic Health Records
- FHIR Smart
- Smart on FHIR
The List resource is a flat, possibly ordered collection of records. List resources are used in many places, including allergies, medications, alerts, family history, medical history, etc. List resources can be used to support patient-specific clinical lists as well as lists that manage workflows such as tracking patients, managing teaching cases, etc.
Get The Data
- ResearchNon-Commercial, Share-Alike, Attribution Free Forever
- CommercialCommercial Use, Remix & Adapt, White Label Log in to download
Resources supported by the List resource can be homogeneous – consisting of only one type of resource (e.g. allergy lists) as well as heterogeneous – containing a variety of resources (e.g. a problem list including Conditions, AllergyIntolerances, recent Procedures, etc.).
Lists will typically include references to the resources that make up the list, however in some cases the details of the content of the list might be expressed in narrative only; e.g. a text record of a family history. The List resource is only needed if there is a need to filter the set of resources by a mechanism that cannot be accomplished via a simple query; e.g. there is no need to have a list for all AllergyIntolerances that exist on a server for a given patient. However, List is an appropriate mechanism to provide a filtered list of the subset of Allergy Intolerances that are deemed to be “current”. Lists are allowed to contain other Lists, to create a nested collection of Lists.
Querying a List of resources such as Allergy Intolerance, Condition or Medication-related resources is different than querying the resource-specific endpoint. For example, a List of Allergy Intolerance resources would represent a curated point-in-time snapshot of the patient’s allergies and intolerances. On the other hand, querying the Allergy Intolerance endpoint would typically produce a larger set of records as it would both be non-curated (potentially containing duplicate or out-of-date records) and current – generated based on information as of “now” rather than the last time a human manually revised the List resource instance. Which mechanism is most appropriate for data retrieval will vary by use-case. In some cases, systems might not have an appropriate curated List to query.
Note that the presence of an item in a List resource shall not change the meaning of any information that would be understood by looking at the item outside the context of the List, because items may be accessed directly outside the List by RESTful means or after a document is processed. For example, a List with a code that means “refuted conditions” cannot have items that are Condition resources that do not have a verification Status of refuted.
The List resource – enumerates a flat collection of resources and provides features for managing the collection. While a particular List instance may represent a “snapshot”, from a business process perspective the notion of “List” is dynamic – items are added and removed over time. The List resource references other resources. Lists may be curated and have specific business meaning.
About this Dataset
John Snow Labs; Health Level Seven International;
|Source License URL|
|Source License Requirements||
FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR
FHIR List Resource, Electronic Health Records Exchange Through FHIR
|Concept_Name||Name of the concept in the FHIR structure.||string||required : 1|
|Computer_Ready_Name||A Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this.||string||-|
|Type||The type the structure describes.||string||-|
|Dollar_Ref||The "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced.||string||-|
|Description||A free text natural language description of the structure and its use.||string||-|
|Items||The value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value.||string||-|
|Enum||The enum is used to restrict a value to a fixed set of values. It must be an array with at least one element, where each element is unique.||string||-|
|Required||The value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value.||string||-|
|Const||The value of this keyword can be anything. The data is valid if it is deeply equal to the value of the keyword.||string||-|
|Concept Name||Computer Ready Name||Type||Dollar Ref||Description||Items||Enum||Required||Const|
|List||resourceType||This is a List resource||List|
|List||id||#/definitions/id||The logical id of the resource|
|List||meta||#/definitions/Meta||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.|
|List||implicitRules||#/definitions/uri||A reference to a set of rules that were followed when the resource was constructed|
|List||_implicitRules||#/definitions/Element||Extensions for implicitRules|
|List||language||#/definitions/code||The base language in which the resource is written.|
|List||_language||#/definitions/Element||Extensions for language|
|List||text||#/definitions/Narrative||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|
|List||contained||array||These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently|
|List||extension||array||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 managable|