List - FHIR Resource (dstu2)


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

Validate an List FHIR Resource (dstu2)



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
notefalsestring# 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 Structure


  
{
  "resourceType" : "List",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier
  "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
  "source" : { Reference(Practitioner|Patient|Device) }, // Who and/or what defined the list contents (aka Author)
  "encounter" : { Reference(Encounter) }, // Context in which list created
  "status" : "<code>", // R!  current | retired | entered-in-error
  "date" : "<dateTime>", // When the list was prepared
  "orderedBy" : { CodeableConcept }, // What order the list has
  "mode" : "<code>", // R!  working | snapshot | changes
  "note" : "<string>", // 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/dstu2/List?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
codetextcode
datedatedate
empty-reasontextemptyReason
encounterreferenceencounter
itemreferenceentry.item
notestextnote
patientreferencesubject
sourcereferencesource
statustextstatus
subjectreferencesubject
titletexttitle