# Composition $convert `POST /Composition/$convert` 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. [Learn about translating between FHIR and CDA](https://docs.redoxengine.com/permalink/k4D3k1pRQYf2Qca46BP31). > **Supported fields and schema examples** > > We support any valid FHIR field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements. > > Our schema examples show the shape and possibility of each FHIR resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. [Consider reviewing FHIR API actions](/fhir-api-actions) for realistic examples for particular use cases. ### $convert Translate CDA entries to FHIR. The request contains the original CDA data, which is returned as a FHIR bundle.  ## Request body Bundle sent as part of a DocumentReference convert message | Field | Type | Required | Description | | --- | --- | --- | --- | | `resourceType` | string | Yes | Identifies the type of the resource. Value: Bundle | | `type` | string | Yes | Identifies this bundle as a message. Value: message | | `entry` | Array of messageHeader or Composition or patient or organization or Other | Yes | An entry in the bundle containing a FHIR resource | | `entry[] (messageHeader).resource` | object | Yes | Additional metadata about the message including the event | | `entry[] (messageHeader).resource.resourceType` | string | Yes | Identifies the type of the resource. Value: MessageHeader | | `entry[] (messageHeader).resource.source` | object | Yes | Information about the sender of the message and the Bundle content. | | `entry[] (messageHeader).resource.source.endpoint` | string | Yes | Identifies the routing target to send acknowledgements to. | | `entry[] (messageHeader).resource.source.name` | string | No | Human-readable name for the source system. | | `entry[] (messageHeader).resource.focus` | Array of object | Yes | This describes the focal target resource of the message from which the remainder of the content is referenced from Must be a resource of type `DocumentReference`. | | `entry[] (messageHeader).resource.focus[].reference` | string | No | 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. | | `entry[] (messageHeader).resource.eventUri` | string | Yes | This describes the message being communicated. Value: https://fhir.redoxengine.com/EventDefinition/DocumentReferenceConvert | | `entry[] (Composition).resource` | object | Yes | The primary DocumentReference to convert | | `entry[] (Composition).resource.resourceType` | string | Yes | Identifies the type of the resource. Value: DocumentReference | | `entry[] (Composition).resource.status` | string | Yes | The status of this document reference. Possible values: current, superseded, entered-in-error | | `entry[] (Composition).resource.subject` | object | Yes | Who or what the document is about. The document 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 farm animals, or a set of patients that share a common exposure). Must be a resource of type `Patient`. | | `entry[] (Composition).resource.subject.reference` | string | No | 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. | | `entry[] (Composition).resource.content` | Array of object | Yes | The document and format referenced. There may be multiple content element repetitions, each with a different format. | | `entry[] (Composition).resource.content[].attachment` | object | Yes | The document or URL of the document along with critical metadata to prove content has integrity. | | `entry[] (Composition).resource.content[].attachment.contentType` | string | No | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. Value: text/xml | | `entry[] (Composition).resource.content[].attachment.data` | string | No | The actual data of the attachment - a sequence of bytes, base64 encoded. | | `entry[] (Composition).resource.id` | string | No | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | | `entry[] (Composition).resource.masterIdentifier` | object | No | Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document. | | `entry[] (Composition).resource.masterIdentifier.extension` | Array of Boolean or String or CodeableConcept or Coding or HumanName or Reference | No | 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. | | `entry[] (Composition).resource.masterIdentifier.extension[] (Boolean).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.masterIdentifier.extension[] (Boolean).valueBoolean` | boolean | No | A single value for the extension. | | `entry[] (Composition).resource.masterIdentifier.extension[] (String).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.masterIdentifier.extension[] (String).valueString` | string | No | A single value for the extension. | | `entry[] (Composition).resource.masterIdentifier.extension[] (CodeableConcept).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.masterIdentifier.extension[] (CodeableConcept).valueCodeableConcept` | object | No | A single value for the extension. | | `entry[] (Composition).resource.masterIdentifier.extension[] (CodeableConcept).valueCodeableConcept.coding` | Array of object | No | A reference to a code defined by a terminology system. | | `entry[] (Composition).resource.masterIdentifier.extension[] (CodeableConcept).valueCodeableConcept.coding[].system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (Composition).resource.masterIdentifier.extension[] (CodeableConcept).valueCodeableConcept.coding[].code` | string | No | 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). | | `entry[] (Composition).resource.masterIdentifier.extension[] (CodeableConcept).valueCodeableConcept.text` | string | No | 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. | | `entry[] (Composition).resource.masterIdentifier.extension[] (Coding).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.masterIdentifier.extension[] (Coding).valueCoding` | object | No | A single value for the extension. | | `entry[] (Composition).resource.masterIdentifier.extension[] (Coding).valueCoding.system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (Composition).resource.masterIdentifier.extension[] (Coding).valueCoding.code` | string | No | 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). | | `entry[] (Composition).resource.masterIdentifier.extension[] (HumanName).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.masterIdentifier.extension[] (HumanName).valueHumanName` | object | No | A single value for the extension. | | `entry[] (Composition).resource.masterIdentifier.extension[] (HumanName).valueHumanName.use` | string | No | Identifies the purpose for this name. Possible values: usual, official, temp, nickname, anonymous, old, maiden | | `entry[] (Composition).resource.masterIdentifier.extension[] (HumanName).valueHumanName.family` | string | No | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | | `entry[] (Composition).resource.masterIdentifier.extension[] (HumanName).valueHumanName.given` | Array of string | No | Given name. | | `entry[] (Composition).resource.masterIdentifier.extension[] (Reference).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.masterIdentifier.extension[] (Reference).valueReference` | object | No | A single value for the extension. | | `entry[] (Composition).resource.masterIdentifier.extension[] (Reference).valueReference.reference` | string | No | 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. | | `entry[] (Composition).resource.masterIdentifier.use` | string | No | The purpose of this identifier. Possible values: usual, official, temp, secondary, old (If known) | | `entry[] (Composition).resource.masterIdentifier.system` | string | No | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | | `entry[] (Composition).resource.masterIdentifier.value` | string | No | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | | `entry[] (Composition).resource.type` | object | No | Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced. | | `entry[] (Composition).resource.type.coding` | Array of object | No | A reference to a code defined by a terminology system. | | `entry[] (Composition).resource.type.coding[].system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (Composition).resource.type.coding[].code` | string | No | 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). | | `entry[] (Composition).resource.type.text` | string | No | 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. | | `entry[] (Composition).resource.category` | Array of object | No | A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type. | | `entry[] (Composition).resource.category[].coding` | Array of object | No | A reference to a code defined by a terminology system. | | `entry[] (Composition).resource.category[].coding[].system` | string | Yes | The identification of the code system that defines the meaning of the symbol in the code. Value: urn:redox:document_kind | | `entry[] (Composition).resource.category[].coding[].code` | string | Yes | 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). Value: CDA | | `entry[] (Composition).resource.category[].text` | string | No | 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. | | `entry[] (Composition).resource.date` | string | No | When the document reference was created. | | `entry[] (Composition).resource.author` | Array of object | No | Identifies who is responsible for adding the information to the document. Must reference one of the following types of resources: - `Practitioner` - `PractitionerRole` - `Organization` - `Device` - `Patient` - `RelatedPerson` | | `entry[] (Composition).resource.author[].reference` | string | No | 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. | | `entry[] (Composition).resource.authenticator` | object | No | Which person or organization authenticates that this document is valid. Must reference one of the following types of resources: - `Practitioner` - `PractitionerRole` - `Organization` | | `entry[] (Composition).resource.authenticator.reference` | string | No | 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. | | `entry[] (Composition).resource.relatesTo` | Array of object | No | Relationships that this document has with other document references that already exist. | | `entry[] (Composition).resource.relatesTo[].code` | string | Yes | The type of relationship that this document has with anther document. Possible values: replaces, transforms, signs, appends | | `entry[] (Composition).resource.relatesTo[].target` | object | Yes | The target document of this relationship. Must be a resource of type `DocumentReference`. | | `entry[] (Composition).resource.relatesTo[].target.extension` | Array of object | No | Additional information about the related document | | `entry[] (Composition).resource.relatesTo[].target.extension[].url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. Value: http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumber | | `entry[] (Composition).resource.relatesTo[].target.extension[].valueInteger` | number | No | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | | `entry[] (Composition).resource.relatesTo[].target.identifier` | object | No | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension` | Array of Boolean or String or CodeableConcept or Coding or HumanName or Reference | No | 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. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (Boolean).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (Boolean).valueBoolean` | boolean | No | A single value for the extension. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (String).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (String).valueString` | string | No | A single value for the extension. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (CodeableConcept).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (CodeableConcept).valueCodeableConcept` | object | No | A single value for the extension. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (CodeableConcept).valueCodeableConcept.coding` | Array of object | No | A reference to a code defined by a terminology system. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (CodeableConcept).valueCodeableConcept.coding[].system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (CodeableConcept).valueCodeableConcept.coding[].code` | string | No | 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). | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (CodeableConcept).valueCodeableConcept.text` | string | No | 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. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (Coding).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (Coding).valueCoding` | object | No | A single value for the extension. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (Coding).valueCoding.system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (Coding).valueCoding.code` | string | No | 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). | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (HumanName).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (HumanName).valueHumanName` | object | No | A single value for the extension. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (HumanName).valueHumanName.use` | string | No | Identifies the purpose for this name. Possible values: usual, official, temp, nickname, anonymous, old, maiden | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (HumanName).valueHumanName.family` | string | No | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (HumanName).valueHumanName.given` | Array of string | No | Given name. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (Reference).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (Reference).valueReference` | object | No | A single value for the extension. | | `entry[] (Composition).resource.relatesTo[].target.identifier.extension[] (Reference).valueReference.reference` | string | No | 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. | | `entry[] (Composition).resource.relatesTo[].target.identifier.use` | string | No | The purpose of this identifier. Possible values: usual, official, temp, secondary, old (If known) | | `entry[] (Composition).resource.relatesTo[].target.identifier.system` | string | No | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | | `entry[] (Composition).resource.relatesTo[].target.identifier.value` | string | No | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | | `entry[] (Composition).resource.description` | string | No | Human-readable description of the source document. | | `entry[] (Composition).resource.context` | object | No | The clinical context in which the document was prepared. | | `entry[] (Composition).resource.context.encounter` | Array of object | No | Describes the clinical encounter or type of care that the document content is associated with. Must reference one of the following types of resources: - `Encounter` - `EpisodeOfCare` | | `entry[] (Composition).resource.context.encounter[].identifier` | object | No | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | | `entry[] (Composition).resource.context.encounter[].identifier.extension` | Array of Boolean or String or CodeableConcept or Coding or HumanName or Reference | No | 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. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (Boolean).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (Boolean).valueBoolean` | boolean | No | A single value for the extension. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (String).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (String).valueString` | string | No | A single value for the extension. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (CodeableConcept).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (CodeableConcept).valueCodeableConcept` | object | No | A single value for the extension. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (CodeableConcept).valueCodeableConcept.coding` | Array of object | No | A reference to a code defined by a terminology system. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (CodeableConcept).valueCodeableConcept.coding[].system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (CodeableConcept).valueCodeableConcept.coding[].code` | string | No | 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). | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (CodeableConcept).valueCodeableConcept.text` | string | No | 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. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (Coding).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (Coding).valueCoding` | object | No | A single value for the extension. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (Coding).valueCoding.system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (Coding).valueCoding.code` | string | No | 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). | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (HumanName).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (HumanName).valueHumanName` | object | No | A single value for the extension. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (HumanName).valueHumanName.use` | string | No | Identifies the purpose for this name. Possible values: usual, official, temp, nickname, anonymous, old, maiden | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (HumanName).valueHumanName.family` | string | No | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (HumanName).valueHumanName.given` | Array of string | No | Given name. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (Reference).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (Reference).valueReference` | object | No | A single value for the extension. | | `entry[] (Composition).resource.context.encounter[].identifier.extension[] (Reference).valueReference.reference` | string | No | 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. | | `entry[] (Composition).resource.context.encounter[].identifier.use` | string | No | The purpose of this identifier. Possible values: usual, official, temp, secondary, old (If known) | | `entry[] (Composition).resource.context.encounter[].identifier.system` | string | No | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | | `entry[] (Composition).resource.context.encounter[].identifier.value` | string | No | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | | `entry[] (Composition).resource.context.period` | object | No | The time period over which the service that is described by the document was provided. | | `entry[] (Composition).resource.context.period.start` | string | No | The start of the period. The boundary is inclusive. | | `entry[] (Composition).resource.context.period.end` | string | No | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | | `entry[] (patient).resource` | object | Yes | The Patient associated with this DocumentReference | | `entry[] (patient).resource.resourceType` | string | Yes | Identifies the type of the resource. Value: Patient | | `entry[] (patient).resource.identifier` | Array of object | Yes | An identifier for this patient. | | `entry[] (patient).resource.identifier[].system` | string | Yes | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | | `entry[] (patient).resource.identifier[].value` | string | Yes | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | | `entry[] (patient).resource.identifier[].extension` | Array of Boolean or String or CodeableConcept or Coding or HumanName or Reference | No | 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. | | `entry[] (patient).resource.identifier[].extension[] (Boolean).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (patient).resource.identifier[].extension[] (Boolean).valueBoolean` | boolean | No | A single value for the extension. | | `entry[] (patient).resource.identifier[].extension[] (String).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (patient).resource.identifier[].extension[] (String).valueString` | string | No | A single value for the extension. | | `entry[] (patient).resource.identifier[].extension[] (CodeableConcept).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (patient).resource.identifier[].extension[] (CodeableConcept).valueCodeableConcept` | object | No | A single value for the extension. | | `entry[] (patient).resource.identifier[].extension[] (CodeableConcept).valueCodeableConcept.coding` | Array of object | No | A reference to a code defined by a terminology system. | | `entry[] (patient).resource.identifier[].extension[] (CodeableConcept).valueCodeableConcept.coding[].system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (patient).resource.identifier[].extension[] (CodeableConcept).valueCodeableConcept.coding[].code` | string | No | 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). | | `entry[] (patient).resource.identifier[].extension[] (CodeableConcept).valueCodeableConcept.text` | string | No | 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. | | `entry[] (patient).resource.identifier[].extension[] (Coding).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (patient).resource.identifier[].extension[] (Coding).valueCoding` | object | No | A single value for the extension. | | `entry[] (patient).resource.identifier[].extension[] (Coding).valueCoding.system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (patient).resource.identifier[].extension[] (Coding).valueCoding.code` | string | No | 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). | | `entry[] (patient).resource.identifier[].extension[] (HumanName).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (patient).resource.identifier[].extension[] (HumanName).valueHumanName` | object | No | A single value for the extension. | | `entry[] (patient).resource.identifier[].extension[] (HumanName).valueHumanName.use` | string | No | Identifies the purpose for this name. Possible values: usual, official, temp, nickname, anonymous, old, maiden | | `entry[] (patient).resource.identifier[].extension[] (HumanName).valueHumanName.family` | string | No | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | | `entry[] (patient).resource.identifier[].extension[] (HumanName).valueHumanName.given` | Array of string | No | Given name. | | `entry[] (patient).resource.identifier[].extension[] (Reference).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (patient).resource.identifier[].extension[] (Reference).valueReference` | object | No | A single value for the extension. | | `entry[] (patient).resource.identifier[].extension[] (Reference).valueReference.reference` | string | No | 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. | | `entry[] (patient).resource.identifier[].use` | string | No | The purpose of this identifier. Possible values: usual, official, temp, secondary, old (If known) | | `entry[] (patient).resource.name` | Array of object | Yes | A name associated with the individual. | | `entry[] (patient).resource.name[].family` | string | No | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | | `entry[] (patient).resource.name[].given` | Array of string | No | Given name. | | `entry[] (patient).resource.name[].use` | string | No | Identifies the purpose for this name. Possible values: usual, official, temp, nickname, anonymous, old, maiden | | `entry[] (patient).resource.gender` | string | Yes | Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Possible values: (USCDI) male, female, other, unknown | | `entry[] (patient).resource.id` | string | No | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | | `entry[] (patient).resource.extension` | Array of race or ethnicity or birthsex or patient-citizenship or Other | No | Additional information about patients not represented by standard FHIR fields. | | `entry[] (patient).resource.extension[] (race).extension` | Array of ombCategory or text | Yes | Sub-extensions to carry more information about the patient's ethnicity | | `entry[] (patient).resource.extension[] (race).extension[] (ombCategory).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. Value: ombCategory | | `entry[] (patient).resource.extension[] (race).extension[] (ombCategory).valueCoding` | object | Yes | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). | | `entry[] (patient).resource.extension[] (race).extension[] (ombCategory).valueCoding.system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (patient).resource.extension[] (race).extension[] (ombCategory).valueCoding.code` | string | No | 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). | | `entry[] (patient).resource.extension[] (race).extension[] (text).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. Value: text | | `entry[] (patient).resource.extension[] (race).extension[] (text).valueString` | string | Yes | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). | | `entry[] (patient).resource.extension[] (race).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | | `entry[] (patient).resource.extension[] (ethnicity).extension` | Array of ombCategory or text | Yes | An Extension | | `entry[] (patient).resource.extension[] (ethnicity).extension[] (ombCategory).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. Value: ombCategory | | `entry[] (patient).resource.extension[] (ethnicity).extension[] (ombCategory).valueCoding` | object | Yes | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). | | `entry[] (patient).resource.extension[] (ethnicity).extension[] (ombCategory).valueCoding.system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (patient).resource.extension[] (ethnicity).extension[] (ombCategory).valueCoding.code` | string | No | 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). | | `entry[] (patient).resource.extension[] (ethnicity).extension[] (text).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. Value: text | | `entry[] (patient).resource.extension[] (ethnicity).extension[] (text).valueString` | string | Yes | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). | | `entry[] (patient).resource.extension[] (ethnicity).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | | `entry[] (patient).resource.extension[] (birthsex).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex | | `entry[] (patient).resource.extension[] (birthsex).valueCode` | string | Yes | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). Only one of `valueBase64Binary`, `valueBoolean`, `valueCanonical`, `valueCode`, `valueDate`, `valueDateTime`, `valueDecimal`, `valueId`, `valueInstant`, `valueInteger`, `valueMarkdown`, `valueOid`, `valuePositiveInt`, `valueString`, `valueTime`, `valueUnsignedInt`, `valueUri`, `valueUrl`, `valueUuid`, `valueAddress`, `valueAge`, `valueAnnotation`, `valueAttachment`, `valueCodeableConcept`, `valueCoding`, `valueContactPoint`, `valueCount`, `valueDistance`, `valueDuration`, `valueHumanName`, `valueIdentifier`, `valueMoney`, `valuePeriod`, `valueQuantity`, `valueRange`, `valueRatio`, `valueReference`, `valueSampledData`, `valueSignature`, `valueTiming`, `valueContactDetail`, `valueContributor`, `valueDataRequirement`, `valueExpression`, `valueParameterDefinition`, `valueRelatedArtifact`, `valueTriggerDefinition`, `valueUsageContext`, `valueDosage`, `valueMeta` may be present. Possible values: M, F | | `entry[] (patient).resource.extension[] (patient-citizenship).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. Value: http://hl7.org/fhir/StructureDefinition/patient-citizenship | | `entry[] (patient).resource.extension[] (patient-citizenship).extension` | Array of object | No | 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. | | `entry[] (patient).resource.extension[] (patient-citizenship).extension[].url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. Value: code | | `entry[] (patient).resource.extension[] (patient-citizenship).extension[].valueCodeableConcept` | object | Yes | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). | | `entry[] (patient).resource.extension[] (patient-citizenship).extension[].valueCodeableConcept.coding` | Array of object | No | A reference to a code defined by a terminology system. | | `entry[] (patient).resource.extension[] (patient-citizenship).extension[].valueCodeableConcept.coding[].system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (patient).resource.extension[] (patient-citizenship).extension[].valueCodeableConcept.coding[].code` | string | No | 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). | | `entry[] (patient).resource.extension[] (patient-citizenship).extension[].valueCodeableConcept.text` | string | No | 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. | | `entry[] (patient).resource.extension[] (Other)` | Boolean or String or CodeableConcept or Coding or HumanName or Reference | No | | | `entry[] (patient).resource.extension[] (Other) (Boolean).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (patient).resource.extension[] (Other) (Boolean).valueBoolean` | boolean | No | A single value for the extension. | | `entry[] (patient).resource.extension[] (Other) (String).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (patient).resource.extension[] (Other) (String).valueString` | string | No | A single value for the extension. | | `entry[] (patient).resource.extension[] (Other) (CodeableConcept).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (patient).resource.extension[] (Other) (CodeableConcept).valueCodeableConcept` | object | No | A single value for the extension. | | `entry[] (patient).resource.extension[] (Other) (CodeableConcept).valueCodeableConcept.coding` | Array of object | No | A reference to a code defined by a terminology system. | | `entry[] (patient).resource.extension[] (Other) (CodeableConcept).valueCodeableConcept.coding[].system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (patient).resource.extension[] (Other) (CodeableConcept).valueCodeableConcept.coding[].code` | string | No | 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). | | `entry[] (patient).resource.extension[] (Other) (CodeableConcept).valueCodeableConcept.text` | string | No | 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. | | `entry[] (patient).resource.extension[] (Other) (Coding).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (patient).resource.extension[] (Other) (Coding).valueCoding` | object | No | A single value for the extension. | | `entry[] (patient).resource.extension[] (Other) (Coding).valueCoding.system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (patient).resource.extension[] (Other) (Coding).valueCoding.code` | string | No | 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). | | `entry[] (patient).resource.extension[] (Other) (HumanName).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (patient).resource.extension[] (Other) (HumanName).valueHumanName` | object | No | A single value for the extension. | | `entry[] (patient).resource.extension[] (Other) (HumanName).valueHumanName.use` | string | No | Identifies the purpose for this name. Possible values: usual, official, temp, nickname, anonymous, old, maiden | | `entry[] (patient).resource.extension[] (Other) (HumanName).valueHumanName.family` | string | No | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | | `entry[] (patient).resource.extension[] (Other) (HumanName).valueHumanName.given` | Array of string | No | Given name. | | `entry[] (patient).resource.extension[] (Other) (Reference).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (patient).resource.extension[] (Other) (Reference).valueReference` | object | No | A single value for the extension. | | `entry[] (patient).resource.extension[] (Other) (Reference).valueReference.reference` | string | No | 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. | | `entry[] (patient).resource.active` | boolean | No | Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. | | `entry[] (patient).resource.telecom` | Array of object | No | A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. | | `entry[] (patient).resource.telecom[].system` | string | Yes | Telecommunications form for contact point - what communications system is required to make use of the contact. Possible values: email, fax, other, pager, sms, url | | `entry[] (patient).resource.telecom[].value` | string | Yes | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). | | `entry[] (patient).resource.telecom[].use` | string | No | Identifies the purpose for the contact point. Possible values: mobile, old, temp, work | | `entry[] (patient).resource.birthDate` | string | No | The date of birth for the individual. | | `entry[] (patient).resource.address` | Array of object | No | An address for the individual. | | `entry[] (patient).resource.address[].line` | Array of string | No | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. | | `entry[] (patient).resource.address[].city` | string | No | The name of the city, town, suburb, village or other community or delivery center. | | `entry[] (patient).resource.address[].state` | string | No | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). | | `entry[] (patient).resource.address[].postalCode` | string | No | A postal code designating a region defined by the postal service. | | `entry[] (patient).resource.address[].use` | string | No | The purpose of this address. Possible values: home, work, temp, old, billing | | `entry[] (patient).resource.address[].district` | string | No | The name of the administrative area (county). | | `entry[] (patient).resource.address[].country` | string | No | Country - a nation as commonly understood or generally accepted. | | `entry[] (patient).resource.contact` | Array of object | No | A contact party (e.g. guardian, partner, friend) for the patient. | | `entry[] (patient).resource.contact[].relationship` | Array of object | No | The nature of the relationship between the patient and the contact. Redox sends and recognizes the following values for system: - `http://terminology.hl7.org/CodeSystem/v3-RoleCode` - used as RelationToPatient - `http://terminology.hl7.org/CodeSystem/v2-0131` - used as the ContactRole | | `entry[] (patient).resource.contact[].relationship[].coding` | Array of object | No | A reference to a code defined by a terminology system. | | `entry[] (patient).resource.contact[].relationship[].coding[].system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (patient).resource.contact[].relationship[].coding[].code` | string | No | 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). | | `entry[] (patient).resource.contact[].relationship[].text` | string | No | 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. | | `entry[] (patient).resource.contact[].name` | object | No | A name associated with the contact person. | | `entry[] (patient).resource.contact[].name.use` | string | No | Identifies the purpose for this name. Possible values: usual, official, temp, nickname, anonymous, old, maiden | | `entry[] (patient).resource.contact[].name.family` | string | No | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | | `entry[] (patient).resource.contact[].name.given` | Array of string | No | Given name. | | `entry[] (patient).resource.contact[].telecom` | Array of object | No | A contact detail for the person, e.g. a telephone number or an email address. | | `entry[] (patient).resource.contact[].telecom[].system` | string | No | Telecommunications form for contact point - what communications system is required to make use of the contact. Possible values: phone, fax, email, pager, url, sms, other | | `entry[] (patient).resource.contact[].telecom[].value` | string | No | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). | | `entry[] (patient).resource.contact[].telecom[].use` | string | No | Identifies the purpose for the contact point. Possible values: home, work, temp, old, mobile | | `entry[] (patient).resource.contact[].address` | object | No | Address for the contact person. | | `entry[] (patient).resource.contact[].address.use` | string | No | The purpose of this address. Possible values: home, work, temp, old, billing | | `entry[] (patient).resource.contact[].address.line` | Array of string | No | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. | | `entry[] (patient).resource.contact[].address.city` | string | No | The name of the city, town, suburb, village or other community or delivery center. | | `entry[] (patient).resource.contact[].address.district` | string | No | The name of the administrative area (county). | | `entry[] (patient).resource.contact[].address.state` | string | No | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). | | `entry[] (patient).resource.contact[].address.postalCode` | string | No | A postal code designating a region defined by the postal service. | | `entry[] (patient).resource.contact[].address.country` | string | No | Country - a nation as commonly understood or generally accepted. | | `entry[] (patient).resource.communication` | Array of object | No | A language which may be used to communicate with the patient about his or her health. | | `entry[] (patient).resource.communication[].language` | object | Yes | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. | | `entry[] (patient).resource.communication[].language.coding` | Array of object | No | A reference to a code defined by a terminology system. | | `entry[] (patient).resource.communication[].language.coding[].system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (patient).resource.communication[].language.coding[].code` | string | No | 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). | | `entry[] (patient).resource.communication[].language.text` | string | No | 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. | | `entry[] (patient).resource.generalPractitioner` | Array of object | No | Patient's nominated care provider. Must be a resource of type `Practitioner`. | | `entry[] (patient).resource.generalPractitioner[].reference` | string | No | 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. | | `entry[] (patient).resource.managingOrganization` | object | No | Organization that is the custodian of the patient record. Must be a resource of type `Organization`. | | `entry[] (patient).resource.managingOrganization.reference` | string | No | 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. | | `entry[] (patient).resource.link` | Array of object | No | Link to another patient resource that concerns the same actual patient. | | `entry[] (patient).resource.link[].other` | object | Yes | The other patient resource that the link refers to. Must be a resource of type `Patient`. | | `entry[] (patient).resource.link[].other.reference` | string | No | 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. | | `entry[] (patient).resource.link[].type` | string | Yes | The type of link between this patient resource and another patient resource. Possible values: replaced-by, replaces | | `entry[] (patient).resource.deceasedBoolean` | boolean | No | Indicates if the individual is deceased or not. Only one of `deceasedBoolean`, `deceasedDateTime` may be present. | | `entry[] (patient).resource.deceasedDateTime` | string | No | Indicates if the individual is deceased or not. Only one of `deceasedBoolean`, `deceasedDateTime` may be present. | | `entry[] (organization).resource` | object | Yes | Organizations leveraged from the DocumentReference | | `entry[] (organization).resource.resourceType` | string | Yes | Identifies the type of the resource. Value: Organization | | `entry[] (organization).resource.active` | boolean | Yes | Whether the organization's record is still in active use. | | `entry[] (organization).resource.name` | string | Yes | A name associated with the organization. | | `entry[] (organization).resource.id` | string | No | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | | `entry[] (organization).resource.identifier` | Array of NPI or Other | No | Identifier for the organization that is used to identify the organization across multiple disparate systems. | | `entry[] (organization).resource.identifier[] (NPI).system` | string | Yes | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Value: http://hl7.org/fhir/sid/us-npi | | `entry[] (organization).resource.identifier[] (NPI).extension` | Array of Boolean or String or CodeableConcept or Coding or HumanName or Reference | No | 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. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (Boolean).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (Boolean).valueBoolean` | boolean | No | A single value for the extension. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (String).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (String).valueString` | string | No | A single value for the extension. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (CodeableConcept).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (CodeableConcept).valueCodeableConcept` | object | No | A single value for the extension. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (CodeableConcept).valueCodeableConcept.coding` | Array of object | No | A reference to a code defined by a terminology system. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (CodeableConcept).valueCodeableConcept.coding[].system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (CodeableConcept).valueCodeableConcept.coding[].code` | string | No | 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). | | `entry[] (organization).resource.identifier[] (NPI).extension[] (CodeableConcept).valueCodeableConcept.text` | string | No | 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. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (Coding).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (Coding).valueCoding` | object | No | A single value for the extension. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (Coding).valueCoding.system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (Coding).valueCoding.code` | string | No | 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). | | `entry[] (organization).resource.identifier[] (NPI).extension[] (HumanName).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (HumanName).valueHumanName` | object | No | A single value for the extension. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (HumanName).valueHumanName.use` | string | No | Identifies the purpose for this name. Possible values: usual, official, temp, nickname, anonymous, old, maiden | | `entry[] (organization).resource.identifier[] (NPI).extension[] (HumanName).valueHumanName.family` | string | No | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (HumanName).valueHumanName.given` | Array of string | No | Given name. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (Reference).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (Reference).valueReference` | object | No | A single value for the extension. | | `entry[] (organization).resource.identifier[] (NPI).extension[] (Reference).valueReference.reference` | string | No | 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. | | `entry[] (organization).resource.identifier[] (NPI).use` | string | No | The purpose of this identifier. Possible values: usual, official, temp, secondary, old (If known) | | `entry[] (organization).resource.identifier[] (NPI).value` | string | No | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | | `entry[] (organization).resource.identifier[] (Other).extension` | Array of Boolean or String or CodeableConcept or Coding or HumanName or Reference | No | 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. | | `entry[] (organization).resource.identifier[] (Other).extension[] (Boolean).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (organization).resource.identifier[] (Other).extension[] (Boolean).valueBoolean` | boolean | No | A single value for the extension. | | `entry[] (organization).resource.identifier[] (Other).extension[] (String).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (organization).resource.identifier[] (Other).extension[] (String).valueString` | string | No | A single value for the extension. | | `entry[] (organization).resource.identifier[] (Other).extension[] (CodeableConcept).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (organization).resource.identifier[] (Other).extension[] (CodeableConcept).valueCodeableConcept` | object | No | A single value for the extension. | | `entry[] (organization).resource.identifier[] (Other).extension[] (CodeableConcept).valueCodeableConcept.coding` | Array of object | No | A reference to a code defined by a terminology system. | | `entry[] (organization).resource.identifier[] (Other).extension[] (CodeableConcept).valueCodeableConcept.coding[].system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (organization).resource.identifier[] (Other).extension[] (CodeableConcept).valueCodeableConcept.coding[].code` | string | No | 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). | | `entry[] (organization).resource.identifier[] (Other).extension[] (CodeableConcept).valueCodeableConcept.text` | string | No | 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. | | `entry[] (organization).resource.identifier[] (Other).extension[] (Coding).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (organization).resource.identifier[] (Other).extension[] (Coding).valueCoding` | object | No | A single value for the extension. | | `entry[] (organization).resource.identifier[] (Other).extension[] (Coding).valueCoding.system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (organization).resource.identifier[] (Other).extension[] (Coding).valueCoding.code` | string | No | 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). | | `entry[] (organization).resource.identifier[] (Other).extension[] (HumanName).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (organization).resource.identifier[] (Other).extension[] (HumanName).valueHumanName` | object | No | A single value for the extension. | | `entry[] (organization).resource.identifier[] (Other).extension[] (HumanName).valueHumanName.use` | string | No | Identifies the purpose for this name. Possible values: usual, official, temp, nickname, anonymous, old, maiden | | `entry[] (organization).resource.identifier[] (Other).extension[] (HumanName).valueHumanName.family` | string | No | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | | `entry[] (organization).resource.identifier[] (Other).extension[] (HumanName).valueHumanName.given` | Array of string | No | Given name. | | `entry[] (organization).resource.identifier[] (Other).extension[] (Reference).url` | string | Yes | Source of the definition for the extension code - a logical name or a URL. | | `entry[] (organization).resource.identifier[] (Other).extension[] (Reference).valueReference` | object | No | A single value for the extension. | | `entry[] (organization).resource.identifier[] (Other).extension[] (Reference).valueReference.reference` | string | No | 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. | | `entry[] (organization).resource.identifier[] (Other).use` | string | No | The purpose of this identifier. Possible values: usual, official, temp, secondary, old (If known) | | `entry[] (organization).resource.identifier[] (Other).system` | string | No | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | | `entry[] (organization).resource.identifier[] (Other).value` | string | No | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | | `entry[] (organization).resource.type` | Array of object | No | The kind(s) of organization that this is. | | `entry[] (organization).resource.type[].coding` | Array of object | No | A reference to a code defined by a terminology system. | | `entry[] (organization).resource.type[].coding[].system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `entry[] (organization).resource.type[].coding[].code` | string | No | 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). | | `entry[] (organization).resource.type[].text` | string | No | 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. | | `entry[] (organization).resource.telecom` | Array of object | No | A contact detail for the organization. | | `entry[] (organization).resource.telecom[].system` | string | No | Telecommunications form for contact point - what communications system is required to make use of the contact. Possible values: phone, fax, email, pager, url, sms, other | | `entry[] (organization).resource.telecom[].value` | string | No | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). | | `entry[] (organization).resource.telecom[].use` | string | No | Identifies the purpose for the contact point. Possible values: home, work, temp, old, mobile | | `entry[] (organization).resource.address` | Array of object | No | An address for the organization. | | `entry[] (organization).resource.address[].line` | Array of string | No | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. | | `entry[] (organization).resource.address[].city` | string | No | The name of the city, town, suburb, village or other community or delivery center. | | `entry[] (organization).resource.address[].state` | string | No | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). | | `entry[] (organization).resource.address[].postalCode` | string | No | A postal code designating a region defined by the postal service. | | `entry[] (organization).resource.address[].country` | string | No | Country - a nation as commonly understood or generally accepted. | | `entry[] (organization).resource.address[].use` | string | No | The purpose of this address. Possible values: home, work, temp, old, billing | | `entry[] (organization).resource.address[].district` | string | No | The name of the administrative area (county). | | `entry[] (organization).resource.partOf` | object | No | The organization of which this organization forms a part. Must be a resource of type `Organization`. | | `entry[] (organization).resource.partOf.reference` | string | No | 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. | | `entry[] (Other)` | object | No | | | `timestamp` | string | No | The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. | ## Request example ```bash curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Composition/$convert' \ --request POST \ --header 'Authorization: Bearer $API_TOKEN' \ --header 'Content-Type: application/fhir+json' \ --data '{ "resourceType": "Bundle", "id": "RedoxDocumentReferenceConvertBundleExample", "type": "message", "entry": [ { "resource": { "eventUri": "https://fhir.redoxengine.com/EventDefinition/DocumentReferenceCreate", "resourceType": "MessageHeader", "id": "84a2b2bd-222f-5922-8e05-960d5e1bbb3f", "source": { "name": "Good Health Clinics", "endpoint": "urn:uuid:05107c08-fe2f-4740-8c1d-c7107d18ebe5" }, "focus": [ { "reference": "DocumentReference/RedoxDocumentReferenceCreateDocRefExample" } ] }, "fullUrl": "urn:uuid:84a2b2bd-222f-5922-8e05-960d5e1bbb3f" }, { "fullUrl": "urn:uuid:5a692bcd-3528-5a11-8994-7df2f4baee8c", "resource": { "resourceType": "DocumentReference", "id": "5a692bcd-3528-5a11-8994-7df2f4baee8c", "content": [ { "attachment": { "contentType": "text/xml", "data": "PC4uLmJhc2UgNjQgZmlsZSBjb250ZW50cy4uLj4=" } } ], "status": "current", "type": { "text": "Empty File" }, "subject": { "reference": "urn:uuid:3e94f018-17c7-5053-b610-b63c9cdcaec0" }, "date": "2022-08-04T14:51:23Z" } }, { "fullUrl": "urn:uuid:3e94f018-17c7-5053-b610-b63c9cdcaec0", "resource": { "resourceType": "Patient", "id": "3e94f018-17c7-5053-b610-b63c9cdcaec0", "meta": { "extension": [ { "url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order", "valueInteger": 1 } ] }, "extension": [ { "extension": [ { "url": "text", "valueString": "White" } ], "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race" }, { "extension": [ { "url": "ombCategory", "valueCoding": { "code": "2135-2", "system": "urn:oid:2.16.840.1.113883.6.238", "display": "Hispanic or Latino" } }, { "url": "text", "valueString": "Hispanic" } ], "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity" } ], "identifier": [ { "value": "0000000001", "system": "urn:redox:health-one:MR" }, { "value": "101-01-0001", "system": "http://hl7.org/fhir/sid/us-ssn" } ], "name": [ { "given": [ "Timothy", "Paul" ], "family": "Bixby", "use": "official" }, { "text": "Billy", "use": "usual" } ], "gender": "male", "birthDate": "2008-01-06", "telecom": [ { "value": "+18088675301", "system": "phone", "use": "home" }, { "value": "+18008675309", "system": "phone", "use": "work" }, { "value": "timothy.bixby@redoxengine.com", "system": "email" } ], "address": [ { "line": [ "4762 Hickory Street" ], "city": "Monroe", "district": "Greene", "state": "WI", "postalCode": "53566", "country": "US", "use": "home" } ], "maritalStatus": { "coding": [ { "code": "M", "system": "http://hl7.org/fhir/v3/MaritalStatus", "display": "Married" } ], "text": "Married" }, "communication": [ { "language": { "coding": [ { "code": "en", "system": "urn:ietf:bcp:47" } ], "text": "English" } } ], "contact": [ { "name": { "given": [ "Barbara" ], "family": "Bixby" }, "telecom": [ { "value": "+18088675303", "system": "phone", "use": "home" }, { "value": "barbara.bixby@redoxengine.com", "system": "email" } ], "address": { "line": [ "4762 Hickory St." ], "city": "Monroe", "district": "Green", "state": "WI", "postalCode": "53566", "country": "USA" }, "relationship": [ { "coding": [ { "code": "MTH", "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "display": "mother" } ], "text": "Mother" }, { "coding": [ { "code": "C", "system": "http://terminology.hl7.org/CodeSystem/v2-0131", "display": "Emergency Contact" } ], "text": "Emergency Contact" } ] } ], "generalPractitioner": [ { "reference": "Practitioner/RedoxPractitionerExamplePat" } ], "managingOrganization": { "reference": "urn:uuid:ce681df7-40d9-5688-ab65-f4e97257b08e" } } }, { "fullUrl": "urn:uuid:ce681df7-40d9-5688-ab65-f4e97257b08e", "resource": { "resourceType": "Organization", "id": "ce681df7-40d9-5688-ab65-f4e97257b08e", "identifier": [ { "value": "1234", "system": "urn:oid:1.2.3.4" } ], "active": true, "name": "Custodial Org", "address": [ { "line": [ "123 Main St" ], "city": "Madison", "state": "WI" } ], "telecom": [ { "value": "1-800-123-4567", "system": "phone" } ], "type": [ { "text": "Test Type" } ] } } ], "timestamp": "2021-06-17T20:33:22.422Z" }' ``` ## Responses ### 200 Operation Response ### 400 Request could not be processed or failed validation | Field | Type | Required | Description | | --- | --- | --- | --- | | `resourceType` | string | Yes | Identifies the type of the resource. Value: OperationOutcome | | `issue` | Array of object | Yes | A structured respresentation of the error that occurred | | `issue[].severity` | string | Yes | Generally `error` or `fatal` Possible values: fatal, error, warning, information | | `issue[].code` | string | Yes | A FHIR category code that describes the general type of issue. See http://hl7.org/fhir/ValueSet/issue-type for details | | `issue[].id` | string | No | If the error occurs in the RedoxEngine, this corresponds to an Error record in the organization. | | `issue[].details` | object | No | Additional details about the error. This may be a text description of the error or a system code that identifies the error. | | `issue[].details.coding` | Array of object | No | A more granular FHIR code for the specific error. Typically from http://hl7.org/fhir/ValueSet/operation-outcome | | `issue[].details.coding[].system` | string | No | The identification of the code system that defines the meaning of the symbol in the code. | | `issue[].details.coding[].code` | string | No | 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). | | `issue[].details.text` | string | No | A human-readable interpretation of the issue code | | `issue[].diagnostics` | string | No | Additional diagnostic information about the issue. | ```json { "resourceType": "OperationOutcome", "issue": [ { "severity": "fatal", "code": "invalid", "details": { "coding": [ { "code": "MSG_BAD_SYNTAX", "system": "http://terminology.hl7.org/CodeSystem/operation-outcome" } ], "text": "Invalid content found in request body." } } ] } ``` ### 401 Authorization is required Same fields as 400. ```json { "resourceType": "OperationOutcome", "issue": [ { "severity": "fatal", "code": "unknown", "details": { "coding": [ { "code": "MSG_AUTH_REQUIRED", "system": "http://terminology.hl7.org/CodeSystem/operation-outcome" } ], "text": "Invalid authorization token" } } ] } ``` ### 500 Internal server error Same fields as 400. ```json { "resourceType": "OperationOutcome", "issue": [ { "severity": "fatal", "code": "processing", "details": { "coding": [ { "code": "MSG_RESOURCE_ID_FAIL", "system": "http://terminology.hl7.org/CodeSystem/operation-outcome" } ], "text": "Unable to allocate resource id." } } ] } ``` ### 503 Service unavailable Same fields as 400. ```json { "resourceType": "OperationOutcome", "issue": [ { "severity": "fatal", "code": "transient", "details": { "text": "System is unable to process this message at this time." } } ] } ```