Composition $convert

Convert a CDA XML file into a FHIR Document Bundle

Response Fields and Example

A Document bundle containing a FHIR representation of a CDA document. The first resource, Composition, contains the glue that ties all the other clinical resources together.

resourceType
required, string

Identifies the type of the resource

Value: Bundle
type
required, string

Indicates the purpose of this bundle - how it is intended to be used.

Value: document
entry
required, [Composition, Patient, AllergyIntolerance, Appointment, CareTeam, Condition, Consent, Coverage, Device, DeviceRequest, DiagnosticReport, Encounter, FamilyMemberHistory, Goals, HealthConcerns, Immunization, Location, MedicationAdministration, MedicationRequest, MedicationStatement, Observation, Organization, Practitioner, PractitionerRole, Procedure, RelatedPerson, ServiceRequest, Specimen, SupplyRequest, Other]

Contains the overall Composition resource and all other resources associated with it

Any of:
resource
required, object

The main clinical document from which all bundle resources are referenced

resourceType
required, string

Identifies the type of the resource

Value: Composition
language
required, string

The base language in which the resource is written.

identifier
required, object

A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.

system
string

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

value
string

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

status
required, string

The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

Possible Values: preliminary, final, amended, entered-in-error
type
required, object

Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.

coding
[object]

A reference to a code defined by a terminology system.

system
string

The identification of the code system that defines the meaning of the symbol in the code.

code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

text
string

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

subject
required, object

Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

Must be a resource of type Patient.

reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

date
required, string

The composition editing time, when the composition was last logically changed by the author.

author
required, [object]

Identifies who is responsible for the information in the composition, not necessarily who typed it in.

Must reference one of the following types of resources:

  • Practitioner
  • PractitionerRole
extension
[DataAbsentReason, Other]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Any of:

Provides a reason why the expected value or elements in the element that is extended are missing.

See http://hl7.org/fhir/StructureDefinition/data-absent-reason for more information

url
required, string

Source of the definition for the extension code - a logical name or a URL.

Value: http://hl7.org/fhir/StructureDefinition/data-absent-reason
valueCode
required, string

The reason a required field is missing

Possible Values: unknown, asked-unknown, temp-unknown, not-asked, asked-declined, masked, not-applicable, unsupported, as-text, error, not-a-number, negative-infinity, positive-infinity, not-performed, not-permitted
reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

title
required, string

Official human-readable label for the composition.

custodian
required, object

Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

Must be a resource of type Organization.

reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

event
required, [object]

event is unsupported, but required by FHIR.

extension
[object]

Identifies this field as unsupported

url
required, string

Source of the definition for the extension code - a logical name or a URL.

Value: http://hl7.org/fhir/StructureDefinition/data-absent-reason
valueCode
required, string

The reason a required field is missing

Value: unsupported
section
required, [AdmissionDiagnosis, AdvanceDirectives, Allergies, Assessment, CareTeam, ChiefComplaint, DischargeDiagnosis, DischargeMedications, Encounters, FamilyHistory, FunctionalStatus, Goals, HealthConcerns, HistoryOfPresentIllness, Immunizations, Instructions, Insurances, Interventions, MedicalEquipment, MedicalHistory, Medications, MedicationsAdministered, Objective, PhysicalExam, PlanOfTreatment, Problems, Procedures, ReasonForReferral, ReasonForVisit, ResolvedProblems, Results, ReviewOfSystems, SocialHistory, Subjective, VitalSigns, Other]

The root of the sections that make up the composition.

Any of:
title
required, string

Human-readable name of section, e.g. Admission Diagnosis

code
required, object

Contains two codes (46241-6 and 42347-5) because C-CDA requires both to identify the section as Admission Diagnosis

coding
required, [HospitalAdmissionDx, AdmissionDx]

An array of two discrete codes

Any of:
code
required, string
Value: 46241-6
system
required, string
Value: http://loinc.org
text
object

A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

status
required, string

The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

Possible Values: generated, extensions, additional, empty
_status
required, object

This element contains extensions for status. Depending on the extensions present it could be used in place of status or contain additional information about status. See the extension element for more details on the possible extensions being sent.

extension
[DataAbsentReason, Other]

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Any of:

Provides a reason why the expected value or elements in the element that is extended are missing.

See http://hl7.org/fhir/StructureDefinition/data-absent-reason for more information

url
required, string

Source of the definition for the extension code - a logical name or a URL.

Value: http://hl7.org/fhir/StructureDefinition/data-absent-reason
valueCode
required, string

The reason a required field is missing

Possible Values: unknown, asked-unknown, temp-unknown, not-asked, asked-declined, masked, not-applicable, unsupported, as-text, error, not-a-number, negative-infinity, positive-infinity, not-performed, not-permitted
div
required, 

The actual narrative content, a stripped down version of XHTML.

entry
[object]

A reference to a discrete resource for the section

Must be a resource of type Condition.

reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

id
string

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

encounter
object

Describes the clinical encounter or type of care this documentation is associated with.

Must be a resource of type Encounter.

reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

id
string

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

meta
object

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

security
[object]

To communicate confidentiality, one security element will contain system = http://terminology.hl7.org/CodeSystem/v3-Confidentiality and a code from the following list: N, R, V.

system
string

The identification of the code system that defines the meaning of the symbol in the code.

code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Open dropdown

This example only includes the Composition and Patient resources, but in a real bundle, every associated resource would be included.