List - FHIR Resource (stu3)
This List Resource uses the FHIR API standard for access and structure.
Validate an List FHIR Resource (stu3)
List Attributes
AttributeField is listTypeDescription
Description: current | retired | entered-in-error
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "current"Learn more about the (List) status FHIR attribute
Description: What the purpose of this list is
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": Learn more about the (List) code FHIR attribute
Description: Who and/or what defined the list contents (aka Author)
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"source": {
"reference": "Patient/example"
}Learn more about the (List) source FHIR attribute
Description: Descriptive name for the list
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": Learn more about the (List) title FHIR attribute
Description: Comments about the list
FHIR Version: stu3
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (List) note FHIR attribute
Description: What order the list has
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"orderedBy": Learn more about the (List) orderedBy FHIR attribute
Description: C? Why list is empty
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"emptyReason": Learn more about the (List) emptyReason FHIR attribute
Description: working | snapshot | changes
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"mode": "changes"Learn more about the (List) mode FHIR attribute
Description: When the list was prepared
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2012-11-25T22:17:00+11:00"Learn more about the (List) date FHIR attribute
Description: C? Entries in the list
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"entry": [
{
"deleted": true,
"item": {
"reference": "Condition/example"
},
"flag": {
"text": "Deleted due to error"
}
},
{
"date": "2012-11-21",
"item": {
"reference": "Condition/example2"
},
"flag": {
"text": "Added"
}
}
]Learn more about the (List) entry FHIR attribute
Description: Business identifier
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "urn:uuid:a9fcea7c-fcdf-4d17-a5e0-f26dda030b59",
"value": "23974652"
}
]Learn more about the (List) identifier FHIR attribute
Description: Context in which list created
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": {
"reference": "Encounter/example"
}Learn more about the (List) encounter FHIR attribute
Description: If all resources have the same subject
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/example"
}Learn more about the (List) subject FHIR attribute
List Example
{
"status": "current",
"resourceType": "List",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <table>\n <thead>\n <tr>\n <th>Condition</th>\n <th>Severity</th>\n <th>Date</th>\n <th>Location</th>\n <th>Status</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>Burnt Ear</td>\n <td>Severe</td>\n <td>24-May 2012</td>\n <td>Left Ear</td>\n <td>deleted</td>\n </tr>\n <tr>\n <td>Asthma</td>\n <td>Mild</td>\n <td>21-Nov 2012</td>\n <td>--</td>\n <td>added</td>\n </tr>\n </tbody>\n </table>\n </div>"
},
"source": {
"reference": "Patient/example"
},
"mode": "changes",
"date": "2012-11-25T22:17:00+11:00",
"entry": [
{
"deleted": true,
"item": {
"reference": "Condition/example"
},
"flag": {
"text": "Deleted due to error"
}
},
{
"date": "2012-11-21",
"item": {
"reference": "Condition/example2"
},
"flag": {
"text": "Added"
}
}
],
"identifier": [
{
"system": "urn:uuid:a9fcea7c-fcdf-4d17-a5e0-f26dda030b59",
"value": "23974652"
}
],
"id": "example",
"encounter": {
"reference": "Encounter/example"
},
"subject": {
"reference": "Patient/example"
}
}List Structure
{
"resourceType" : "List",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier
"status" : "<code>", // R! current | retired | entered-in-error
"mode" : "<code>", // R! working | snapshot | changes
"title" : "<string>", // Descriptive name for the list
"code" : { CodeableConcept }, // What the purpose of this list is
"subject" : { Reference(Patient|Group|Device|Location) }, // If all resources have the same subject
"encounter" : { Reference(Encounter) }, // Context in which list created
"date" : "<dateTime>", // When the list was prepared
"source" : { Reference(Practitioner|Patient|Device) }, // Who and/or what defined the list contents (aka Author)
"orderedBy" : { CodeableConcept }, // What order the list has
"note" : [{ Annotation }], // Comments about the list
"entry" : [{ // C? Entries in the list
"flag" : { CodeableConcept }, // Status/Workflow information about this item
"deleted" : <boolean>, // C? If this item is actually marked as deleted
"date" : "<dateTime>", // When item added to list
"item" : { Reference(Any) } // R! Actual entry
}],
"emptyReason" : { CodeableConcept } // C? Why list is empty
}
List Search Parameters
The following search parameters can be used to query List resources. Just submit them like so:
https://api.1up.health/fhir/stu3/List?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
code | text | code |
date | date | date |
empty-reason | text | emptyReason |
encounter | reference | encounter |
identifier | text | identifier |
item | reference | entry.item |
notes | text | note.text |
patient | reference | subject |
source | reference | source |
status | text | status |
subject | reference | subject |
title | text | title |
