This resource can be used to convert data between Clinical Document Architecture (CDA) and FHIR®. Use the general $convert operation to translate to FHIR®, and use the specific $convert-to-cda for translating to CDA.
$convert-to-cda
Translate FHIR® bundles to CDA entries.
cURL request example
Request Body Schema
- resourceTyperequired, string
Identifies the type of the resource
Value:Bundle - typerequired, string
Indicates the purpose of this bundle - how it is intended to be used.
Value:document - entryrequired, Array of Composition, Patient, AllergyIntolerance, Condition
Contains the overall Composition resource and all other resources associated with it
- resourcerequired, object
The main clinical document from which all bundle resources are referenced
- resourceTyperequired, string
Identifies the type of the resource
Value:Composition - languagerequired, string
The base language in which the resource is written.
- identifierrequired, object
A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
- systemstring
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- valuestring
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
- statusrequired, 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 - typerequired, 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.
- codingArray of object
A reference to a code defined by a terminology system.
- systemstring
The identification of the code system that defines the meaning of the symbol in the code.
- codestring
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).
- textstring
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.
- subjectrequired, 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.- referencestring
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.
- daterequired, string
The composition editing time, when the composition was last logically changed by the author.
- authorrequired, Array of 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:
PractitionerPractitionerRole
- extensionArray of DataAbsentReason or 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.
- urlrequired, string
Source of the definition for the extension code - a logical name or a URL.
Value:http://hl7.org/fhir/StructureDefinition/data-absent-reason - valueCoderequired, 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
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
- referencestring
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.
- titlerequired, string
Official human-readable label for the composition.
- custodianrequired, 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.- referencestring
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.
- eventrequired, Array of object
event is unsupported, but required by FHIR.
- extensionArray of object
Identifies this field as unsupported
- urlrequired, string
Source of the definition for the extension code - a logical name or a URL.
Value:http://hl7.org/fhir/StructureDefinition/data-absent-reason - valueCoderequired, string
The reason a required field is missing
Value:unsupported
- sectionrequired, Array of Allergies, Encounters, Immunizations, Medications
The root of the sections that make up the composition.
- titlerequired, string
Human-readable name of section, e.g.
Allergies - coderequired, object
LOINC code of
48765-2programmatically identifying section as Allergies- codingrequired, Array of object
A discrete code
- systemrequired, stringValue:
http://loinc.org - coderequired, string
Identifies the section as Allergies
Value:48765-2
- textobject
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.
- statusrequired, 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 - _statusrequired, object
This element contains extensions for
status. Depending on the extensions present it could be used in place ofstatusor contain additional information aboutstatus. See theextensionelement for more details on the possible extensions being sent.- extensionArray of DataAbsentReason or 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.
- urlrequired, string
Source of the definition for the extension code - a logical name or a URL.
Value:http://hl7.org/fhir/StructureDefinition/data-absent-reason - valueCoderequired, 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
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
- divrequired,
The actual narrative content, a stripped down version of XHTML.
- entryArray of object
A reference to a discrete resource for the section
Must be a resource of type
AllergyIntolerance.- referencestring
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.
- idstring
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- extensionArray of version_number_extension or Other
An Extension
An Extension
See http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumber for more information
- encounterobject
Describes the clinical encounter or type of care this documentation is associated with.
Must be a resource of type
Encounter.- referencestring
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.
- attesterArray of legal_attester, professional_attester, personal_attester or Other
A participant who has attested to the accuracy of the composition/document.
- moderequired, string
The type of attestation the authenticator offers.
Value:legal - partyrequired, object
Who attested the composition in the specified way.
Must reference one of the following types of resources:
PatientRelatedPersonPractitionerPractitionerRoleOrganization
- referencestring
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.
- timestring
When the composition was attested by the party.
- relatesToArray of relatedCDADocument, originalDocument or Other
Relationships that this composition has with other compositions or documents that already exist.
The type of relationship that this composition has with anther composition or document.
Possible Values:replaces,transforms,signs,appendsThe target composition/document of this relationship.
Only one of
targetIdentifier,targetReferencemay be present.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.
Source of the definition for the extension code - a logical name or a URL.
A single value for the extension.
The purpose of this identifier.
Possible Values:usual,official,temp,secondary,old (If known)Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Additional information about the related document
Source of the definition for the extension code - a logical name or a URL.
Value:http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumberValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- idstring
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- metaobject
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.
- securityArray of object
To communicate confidentiality, one security element will contain system =
http://terminology.hl7.org/CodeSystem/v3-Confidentialityand a code from the following list:N,R,V.- systemstring
The identification of the code system that defines the meaning of the symbol in the code.
- codestring
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).
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.