Composition - FHIR Resource (dstu2)
This Composition Resource uses the FHIR API standard for access and structure.
Validate an Composition FHIR Resource (dstu2)
Composition Attributes
AttributeField is listTypeDescription
Description: preliminary | final | amended | entered-in-error
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (Composition) status FHIR attribute
Description: As defined by affinity domain
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"confidentiality": Learn more about the (Composition) confidentiality FHIR attribute
Description: Who and/or what authored the composition
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"author": Learn more about the (Composition) author FHIR attribute
Description: Organization which maintains the composition
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"custodian": Learn more about the (Composition) custodian FHIR attribute
Description: Attests to accuracy of composition
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"attester": Learn more about the (Composition) attester FHIR attribute
Description: Human Readable name/title
FHIR Version: dstu2
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 (Composition) title FHIR attribute
Description: Categorization of Composition
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"class": Learn more about the (Composition) class FHIR attribute
Description: Composition is broken into sections
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"section": Learn more about the (Composition) section FHIR attribute
Description: Composition editing time
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": Learn more about the (Composition) date FHIR attribute
Description: Logical identifier of composition (version-independent)
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Composition) identifier FHIR attribute
Description: Kind of composition (LOINC if possible)
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (Composition) type FHIR attribute
Description: The clinical service(s) being documented
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"event": Learn more about the (Composition) event FHIR attribute
Description: Context of the Composition
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": Learn more about the (Composition) encounter FHIR attribute
Description: Who and/or what the composition is about
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": Learn more about the (Composition) subject FHIR attribute
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 them like so:
https://api.1up.health/fhir/dstu2/Composition?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
attester | reference | attester.party |
author | reference | author |
class | text | class |
confidentiality | text | confidentiality |
context | text | event.code |
date | date | date |
encounter | reference | encounter |
entry | reference | section.entry |
identifier | text | identifier |
patient | reference | subject |
period | date | event.period |
section | text | section.code |
status | text | status |
subject | reference | subject |
title | text | title |
type | text | type |
