Composition - FHIR Resource (dstu2)


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

Resource Attributes

AttributeField is listTypeDescription
attestertrueData Type Attests to accuracy of composition
authortrueReference Who and/or what authored the composition
classfalseCodeableConcept Categorization of Composition
confidentialityfalsecode As defined by affinity domain
custodianfalseReference Organization which maintains the composition
datefalsedateTime Composition editing time
encounterfalseReference Context of the Composition
eventtrueData Type The clinical service(s) being documented
identifierfalseIdentifier Logical identifier of composition (version-independent)
sectiontrueData Type Composition is broken into sections
statusfalsecode preliminary | final | amended | entered-in-error
subjectfalseReference Who and/or what the composition is about
titlefalsestring Human Readable name/title
typefalseCodeableConcept Kind of composition (LOINC if possible)

Composition Structure


  
{
  "resourceType" : "Composition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Logical identifier of composition (version-independent)
  "date" : "<dateTime>", // R!  Composition editing time
  "type" : { CodeableConcept }, // R!  Kind of composition (LOINC if possible)
  "class" : { CodeableConcept }, // Categorization of Composition
  "title" : "<string>", // R!  Human Readable name/title
  "status" : "<code>", // R!  preliminary | final | amended | entered-in-error
  "confidentiality" : "<code>", // As defined by affinity domain
  "subject" : { Reference(Any) }, // R!  Who and/or what the composition is about
  "author" : [{ Reference(Practitioner|Device|Patient|RelatedPerson) }], // R!  Who and/or what authored the composition
  "attester" : [{ // Attests to accuracy of composition
    "mode" : ["<code>"], // R!  personal | professional | legal | official
    "time" : "<dateTime>", // When composition attested
    "party" : { Reference(Patient|Practitioner|Organization) } // Who attested the composition
  }],
  "custodian" : { Reference(Organization) }, // Organization which maintains the composition
  "event" : [{ // The clinical service(s) being documented
    "code" : [{ CodeableConcept }], // Code(s) that apply to the event being documented
    "period" : { Period }, // The period covered by the documentation
    "detail" : [{ Reference(Any) }] // The event(s) being documented
  }],
  "encounter" : { Reference(Encounter) }, // Context of the Composition
  "section" : [{ // Composition is broken into sections
    "title" : "<string>", // Label for section (e.g. for ToC)
    "code" : { CodeableConcept }, // Classification of section (recommended)
    "text" : { Narrative }, // C? Text summary of the section, for human interpretation
    "mode" : "<code>", // working | snapshot | changes
    "orderedBy" : { CodeableConcept }, // Order of section entries
    "entry" : [{ Reference(Any) }], // C? A reference to data that supports this section
    "emptyReason" : { CodeableConcept }, // C? Why the section is empty
    "section" : [{ Content as for Composition.section }] // C? Nested Section
  }]
}


 

Composition Search Parameters

The following search parameters can be used to query Composition resources. Just submit the like so:

https://api.1up.health/fhir/dstu2/Composition?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
attesterreferenceattester.party
authorreferenceauthor
classtextclass
confidentialitytextconfidentiality
contexttextevent.code
datedatedate
encounterreferenceencounter
entryreferencesection.entry
identifiertextidentifier
patientreferencesubject
perioddateevent.period
sectiontextsection.code
statustextstatus
subjectreferencesubject
titletexttitle
typetexttype