List - FHIR Resource (stu3)


This List Resource uses the FHIR API standard for access and structure.

Resource Attributes

AttributeField is listTypeDescription
codefalseCodeableConcept What the purpose of this list is
datefalsedateTime When the list was prepared
emptyReasonfalseCodeableConcept C? Why list is empty
encounterfalseReference Context in which list created
entrytrueData Type C? Entries in the list
identifiertrueIdentifier Business identifier
modefalsecode working | snapshot | changes
notetrueAnnotation Comments about the list
orderedByfalseCodeableConcept What order the list has
sourcefalseReference Who and/or what defined the list contents (aka Author)
statusfalsecode current | retired | entered-in-error
subjectfalseReference If all resources have the same subject
titlefalsestring Descriptive name for the list

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 the like so:

https://api.1up.health/fhir/stu3/List?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
codetextcode
datedatedate
empty-reasontextemptyReason
encounterreferenceencounter
identifiertextidentifier
itemreferenceentry.item
notestextnote.text
patientreferencesubject
sourcereferencesource
statustextstatus
subjectreferencesubject
titletexttitle