DocumentReference Profile
This DocumentReference profile is part of the set of resource profiles supported by the API Server used with the athenaPractice 12.3 and athenaFlow 9.12 products. It further describes read, search, create and update capabilities of these products.
Overview
This resource references a document.
Scope and Usage
This profile is used to define the content that will be returned by the API Server in response to requests to access DocumentReference resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
The profile also defines the content that must be supplied to the API Server in response to requests to populate DocumentReference resources. Fields which are marked as Mandatory in this profile are those that must be supplied to the API Server in content used to populate a resource.
Source
The DocumentReference resource is used to access or create documents related to the patient. Content of the resource derives from the DOCUMENT table in athenaPractice and athenaFlow, and the PatientProfileAttachment and PatietVisitAttachment tables in athenaPractice. Specific detail can be found in the Mappings section in the profile detail page.
Supported Operations
The operations supported by this resource are listed below.
Read Operation
Read operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To read a DocumentReference, an application shall perform an HTTP GET, specifying the identifier of the resources being retrieved.
GET [base]/fhir/DocumentReference/[id]{?_format=[json|xml]&_summary=[true|data]}
Read Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [id] | Specifies the identifier of the DocumentReference resource to retrieve |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| [_summary] | Filters the output to include only summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides slightly improved API response times. |
Read Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The requested resource was found and is contained within the body of the HTTP response. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 404 Not Found | The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates that the resource could not be found. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Search Operation
Search operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for DocumentReference resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.
GET [base]/fhir/DocumentReference?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}
Search Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [_count] | Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results DocumentReference resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the AthenaHealth Partner program. Note: The API Server support the HL7 FHIR Paging capability. |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| [_summary] | Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets. |
| _id (token ) | The ID of the resource |
| _lastUpdated (date ) | |
| _lastUpdated-fromnow (quantity ) | Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time , e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| _security (token ) | |
| authenticator (reference ) | Who/what authenticated the document |
| author (reference ) | Who and/or what authored the document |
| class (token ) | Categorization of document |
| created (date ) | Document creation time |
| created-fromnow (quantity ) | Like created except expressed as a positive or negative offset from the current time in units of time , e.g. created-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| custodian (reference ) | Organization which maintains the document |
| description (string ) | Human-readable description (title) |
| encounter (reference ) | Context of the document content |
| facility (token ) | Kind of facility where patient was seen |
| identifier (token ) | Master Version Specific Identifier |
| indexed (date ) | When this document reference created |
| indexed-fromnow (quantity ) | Like indexed except expressed as a positive or negative offset from the current time in units of time , e.g. indexed-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| patient (reference ) | Who/what is the subject of the document |
| period (date ) | Time of service that is being documented |
| period-fromnow (quantity ) | Like period except expressed as a positive or negative offset from the current time in units of time , e.g. period-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| relatesto (reference ) | Target of the relationship |
| relation (token ) | replaces | transforms | signs | appends |
| status (token ) | current | superseded | entered-in-error |
| subject (reference ) | Who/what is the subject of the document |
| type (token ) | Kind of document (LOINC if possible) |
Search Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Create Operation
Create operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To create a new DocumentReference resource, an application must perform an HTTP POST, specifying the content of the resource in the body of the request.
POST [base]/fhir/DocumentReference?{_format=[json|xml]}
Create Operation Parameters
| Parameter | Description |
|---|---|
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
Create Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 201 Created | The resource was created at the location specified in the HTTP Location header. Note: Unsupported fields will be accepted in a request but will not be persisted to the database. Some fields may be mapped to database specific codes which closely but not perfectly match the input. See the HL7 FHIR specification for more detail on server permitted changes. |
| 400 Bad Request | The resource could not be parsed, or failed basic validation rules. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 422 Unprocessable Entity | The proposed resource violated server business rules. For example, a required field may be missing or a field may contain a value that is not supported by the API Server. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Update Operation
Update operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To create a new DocumentReference resource, an application must perform an HTTP PUT, specifying the content of the resource in the body of the request.
PUT [base]/fhir/DocumentReference/[id]?{_format=[json|xml]}
Update Operation Parameters
| Parameter | Description |
|---|---|
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
Update Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The resource was updated at the location specified in the HTTP Location header. Note: Unsupported fields will be accepted in a request but will not be persisted to the database. Some fields may be mapped to database specific codes which closely but not perfectly match the input. See the HL7 FHIR specification for more detail on server permitted changes. |
| 400 Bad Request | The resource could not be parsed, or failed basic validation rules. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 422 Unprocessable Entity | The proposed resource violated server business rules. For example, a required field may be missing or a field may contain a value that is not supported by the API Server. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Other Operations
This Implementation guide defines 3 operations:
| $generate | Generate Document |
| $convert-cda | Generate Wrapped CDA Document |
| $docref | Argonaut Get DocumentReferences |
For more information about operations, including how they are invoked, see Operations .
Generate Document
Generate a CDA or other standards based document from resource data associated with the patient referenced by patient parameter below.
GET [base]/$generate?{operation-parameters}| In Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| patient | 0..1 | reference | A reference to the patient for whom the document will be generated. The document will include data from this patient's record. Patient can be omitted when the patient for whom the document is being generated can be inferred from other parameters. | ||
| type | 0..1 | token | Document Type Value Set (Preferred ) | The type of document to be generated. | |
| class | 0..1 | token | Document Class Value Set (Preferred ) | The document class to be generated. | |
| format | 0..* | token | Document Format Value Set (Preferred ) | The format to be used when generating the document. | |
| contentType | 0..1 | token | MimeType (Required ) | The contentType of the document to be generated. | |
| author | 0..* | reference | The author of the document. Must be a legal reference to a Patient or Practitioner known to the current system. | ||
| authenticator | 0..1 | reference | The legal authenticator of the document. Must be a legal reference to a Patient or Practitioner known to the current system. | ||
| encounter | 0..1 | reference | The encounter associated with the document. Must be a legal reference to an Encounter known to the current system. | ||
| order | 0..1 | reference | The referral or test order to be used when generating documents where class indicates a Transition of Care. | ||
| fromDate | 0..1 | date | Start date of the time period associated with the data elements. | ||
| toDate | 0..1 | date | End date of the time period associated with the data elements. | ||
| description | 0..1 | string | A description to include within the DocumentReference returned by this operation. | ||
| exclusions | 0..* | uri | URIs identifing resources to exclude from the document. | ||
| persist | 0..1 | boolean | If true, the generated document will be persisted. The default if not specified is false. | ||
| securityLabel | 0..* | token | Security tags to be associated with this docment. | ||
| raw | 0..1 | boolean | true | false | ||
| Out Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| return | 1..1 | DocumentReference | Binary | A populated DocumentReference or Binary resource containing metadata about the document and the body of the document in the content attachment (when raw=false or is omitted), or just the body of the document (when raw=true). | ||
The $generate operation constructs a document from resource data available for the specified subject.
Generate Wrapped CDA Document
Wrap the contents of this document in a CDA Header
GET [base]/$convert-cda?{operation-parameters}| In Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| conformance | 0..1 | code | Document Class Value Set (Required ) | Level1 | CCDA2.1 | XDS-SD | |
| contentType | 0..1 | code | Content Type Code Value Set for $convert-cda Operation (Required ) | text/plain | application/pdf | text/html | |
| raw | 0..1 | string | true | false | body | ||
| Out Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| return | 1..1 | DocumentReference | Binary | The returned document. | ||
The $convert-cda operation constructs a CDA Document from the referenced content, optionally converting it to a different format (e.g., PDF, HTML or plain text). The content conforms to CDA Level 1 (a header and nonXMLBody), and may also conform to the HL7 CCDA 2.1 Unstructured Body or the IHE Scanned Document formats.
Argonaut Get DocumentReferences
This operation implements the $docref operation specified in the Argonaut profile of the DocumentReference Resource.
GET [base]/$docref?{operation-parameters}| In Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| patient | 1..1 | reference | The identifier of the patient for whom to generate the CDA document. | ||
| Out Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| return | 1..1 | DocumentReference | Binary | The resulting DocumentReference resource. | ||
The $docref operation implements the Argonaut specified operation on DocumentReference Resource produce a CCD document for the most recent patient encounter. The resulting DocumentReference contains a link to the URL which will produce the requested content.
Profile Content
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/documentreference-profile
A reference to a document
| Name | Flags | Card. | Type | Description & Constraints | |
|---|---|---|---|---|---|
  DocumentReference | ∑ | 0..* | DocumentReference | A reference to a document | |
 meta | ∑ | 0..1 | Meta | Metadata about the resource | |
 implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created | |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47  (required ) | ||
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | ||
 documentreference-refprovid | 0..1 | Reference (Reference) | Extension | ||
 url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-refprovid" | ||
  valueReference | 1..1 | Reference (Reference) | Value of extension | ||
| extension | 0..1 | ?? [UriType[http://hl7.org/fhir/StructureDefinition/documentreference-pubtime]] | Extensionhttp://hl7.org/fhir/StructureDefinition/documentreference-pubtime | ||
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-pubtime" | ||
| valueDateTime | 1..1 | dateTime | Value of extension | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
 masterIdentifier | ∑ | 0..1 | Identifier | Master Version Specific Identifier | |
 identifier | ∑ | Identifier | Other identifiers for the document Slice: Unordered, Closed, by system | ||
| identifier | ∑ | 0..* | Identifier | Other identifiers for the document | |
| identifier | ∑ | 0..* | Identifier | Other identifiers for the document | |
| identifier | ∑ | 0..* | Identifier | Other identifiers for the document | |
| subject | ∑ | 0..1 | Reference (Patient ) | Who/what is the subject of the document | |
| type | ∑ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Document Type Value Set (preferred ) | |
| class | ∑ | 0..1 | CodeableConcept | Categorization of document Binding: Document Class Value Set (example ) | |
| author | ∑ | 0..* | Reference (Practitioner ) | Who and/or what authored the document | |
| custodian | ∑ | 0..1 | Reference (Organization ) | Organization which maintains the document | |
| authenticator | ∑ | 0..1 | Reference (Practitioner ) | Who/what authenticated the document | |
| created | ∑ | 0..1 | dateTime | Document creation time | |
| indexed | ∑ | 1..1 | instant | When this document reference created | |
| status | ?! ∑ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required ) | |
| docStatus | ∑ | 0..1 | CodeableConcept | preliminary | final | appended | amended | entered-in-error Binding: CompositionStatus (required ) | |
| relatesTo | ?! ∑ | 0..* | BackboneElement | Relationships to other documents | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| code | ∑ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required ) | |
| target | ∑ | 1..1 | Reference (DocumentReference ) | Target of the relationship | |
| description | ∑ | 0..1 | string | Human-readable description (title) | |
| securityLabel | ∑ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible ) | |
| content | ∑ | BackboneElement | Document referenced Slice: Unordered, Closed, by type use | ||
| content | ∑ | 1..3 | BackboneElement | Document referenced | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| attachment | ∑ | 1..1 | Attachment | Where to access the document | |
| format | ∑ | 0..* | Coding | Format/content rules for the document Binding: DocumentReference Format Code Set (preferred ) | |
| content | ∑ | 1..* | BackboneElement | Document referenced | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| attachment | ∑ | 1..1 | Attachment | Where to access the document | |
| format | ∑ | 0..* | Coding | Format/content rules for the document Binding: DocumentReference Format Code Set (preferred ) | |
| content | ∑ | 1..* | BackboneElement | Document referenced | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| attachment | ∑ | 1..1 | Attachment | Where to access the document | |
| format | ∑ | 0..* | Coding | Format/content rules for the document Binding: DocumentReference Format Code Set (preferred ) | |
| content | ∑ | 1..* | BackboneElement | Document referenced | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| attachment | ∑ | 1..1 | Attachment | Where to access the document | |
| format | ∑ | 0..* | Coding | Format/content rules for the document Binding: DocumentReference Format Code Set (preferred ) | |
| context | ∑ | 0..1 | BackboneElement | Clinical context of document | |
 extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| encounter | ∑ | 0..1 | Reference (Encounter ) | Context of the document content | |
| event | ∑ | 0..* | CodeableConcept | Main Clinical Acts Documented Binding: v3 Code System ActCode (example ) | |
| period | ∑ | 0..1 | Period | Time of service that is being documented | |
| facilityType | ∑ | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: Facility Type Code Value Set (example ) | |
| practiceSetting | ∑ | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Setting Code Value Set (example ) | |
| sourcePatientInfo | ∑ | 0..1 | Reference (Patient ) | Patient demographics from source | |
| related | ∑ | 0..* | BackboneElement | Related identifiers or resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| identifier | ∑ | 0..1 | Identifier | Identifier of related objects or events | |
| ref | ∑ | 0..1 | Reference (Resource ) | Related Resource | |
athenaPractice Mapping
The mappings in this section represent the how data stored within athenaPractice is served through the product's APIs. athenaPractice and athenaFlow share a common schema for patient clinical data and only one is shown when these are the same. Use of this information is subject to the the API Server Terms and Conditions.
| DocumentReference Profile | ||
| DocumentReference | DocumentReference-Profile | FHIR_DOCUMENTREFERENCEVIEW |
| ├ id | SDID | MakeIdWithPrefix(%ATTACHMENTID%,%ID_PREFIX%) |
| ├ extension | refprovid | |
| ├ extension | PUBTIME | |
| │ └ valueDateTime | getDateFromId(%PUBTIME%) | |
| ├ masterIdentifier | SDID | MakeIdentifier("U",getSiteSystem("DocumentReferenceId"),%ATTACHMENTID%,%ID_PREFIX%) |
| ├ identifier | Document Identifiers | |
| ├ identifier | EXTID | |
| ├ identifier | VISDOC | |
| ├ subject | PID | MakeReference("PERSON",%PID%,"Patient") |
| ├ type | DESCRIPTION | MapConcept(%TYPE%,"DOCUMENTTYPE") |
| ├ class | MapConcept(%TYPE%,"DOCUMENTCLASS") | |
| ├ author | PUBUSER | MakeReferenceList("USR",%AUTHOR%,"Practitioner") |
| ├ custodian | LOCID | MakeReference("LOCREG",%FACILITYID%,"Organization") |
| ├ authenticator | PUBUSER | MakeReference("USR",%USRID%,"Practitioner") |
| ├ created | DB_CREATE_DATE | %CREATED% |
| ├ indexed | DB_CREATE_DATE | %CREATED% |
| ├ status | XID | MapCode(%DOCREFSTATUS%,"DOCUMENTREFERENCESTATUS") |
| ├ docStatus | STATUS | MapConcept(%STATUS%,"DOCSTATUS") |
| ├ relatesTo | REPLACEDBY | |
| │ ├ code | MapCode(%RELATESTOCODE%,"DOCUMENTRELATESTO") | |
| │ └ target | MakeReference("DOCUMENTREFERENCE",%RELATESTOTARGET%,"DocumentReference") | |
| ├ description | DESCRIPTION | %NAME% |
| ├ content | Attachments | |
| ├ content | InternalAttachment | MakeDocRefContentComponentForBinary(%INTREFERENCE%, %INTREFERENCEFORMAT%) |
| ├ content | InternalAttachment2 | MakeDocRefContentComponentForBinary(%INTREFERENCE2%, %INTREFERENCEFORMAT2%) |
| └ content | ExternalAttachment | MakeDocRefContentComponentForExtReferencedBinaryList(%EXTREFERENCE%, %EXTREFERENCEURL%) |
| ├ encounter | SDID | MakeReference("DOCUMENT",%DOCUMENTID%,"Encounter") |
| ├ period | CLINICALDATE | MakeEMRPeriod(%CLINICALDATE%) |
| ├ facilityType | LOCNAME | MakeTextConcept(%SITE%) |
| └ sourcePatientInfo | PID | MakeReference("PERSON",%PID%,"Patient") |
athenaFlow Mapping
The mappings in this section represent the how data stored within athenaFlow is served through the product's APIs.
Use of this information is subject to the API Server
Terms and Conditions .
| DocumentReference Profile | ||
| DocumentReference | DocumentReference-Profile | FHIR_DOCUMENTREFERENCEVIEW |
| ├ id | SDID | MakeId("DOCUMENT",%ATTACHMENTID%) |
| ├ extension | refprovid | |
| ├ extension | PUBTIME | |
| │ └ valueDateTime | getDateFromId(%PUBTIME%) | |
| ├ masterIdentifier | SDID | MakeIdentifier("U",getSiteSystem("DocumentReferenceId"),%ATTACHMENTID%) |
| ├ identifier | Document Identifiers | |
| ├ identifier | EXTID | |
| ├ identifier | VISDOC | |
| ├ subject | PID | MakeReference("PERSON",%PID%,"Patient") |
| ├ type | DESCRIPTION | MapConcept(%TYPE%,"DOCUMENTTYPE") |
| ├ class | MapConcept(%TYPE%,"DOCUMENTCLASS") | |
| ├ author | PUBUSER | MakeReferenceList("USR",%AUTHOR%,"Practitioner") |
| ├ custodian | LOCID | MakeReference("LOCREG",%FACILITYID%,"Organization") |
| ├ authenticator | PUBUSER | MakeReference("USR",%USRID%,"Practitioner") |
| ├ created | DB_CREATE_DATE | %CREATED% |
| ├ indexed | DB_CREATE_DATE | %CREATED% |
| ├ status | XID | MapCode(%DOCREFSTATUS%,"DOCUMENTREFERENCESTATUS") |
| ├ docStatus | STATUS | MapConcept(%STATUS%,"DOCSTATUS") |
| ├ relatesTo | REPLACEDBY | |
| │ ├ code | MapCode(%RELATESTOCODE%,"DOCUMENTRELATESTO") | |
| │ └ target | MakeReference("DOCUMENTREFERENCE",%RELATESTOTARGET%,"DocumentReference") | |
| ├ description | DESCRIPTION | %NAME% |
| ├ content | Attachments | |
| ├ content | InternalAttachment | MakeDocRefContentComponentForBinary(%INTREFERENCE%, %INTREFERENCEFORMAT%) |
| ├ content | InternalAttachment2 | MakeDocRefContentComponentForBinary(%INTREFERENCE2%, %INTREFERENCEFORMAT2%) |
| └ content | ExternalAttachment | MakeDocRefContentComponentForExtReferencedBinaryList(%EXTREFERENCE%, %EXTREFERENCEURL%) |
| ├ encounter | SDID | MakeReference("DOCUMENT",%DOCUMENTID%,"Encounter") |
| ├ period | CLINICALDATE | MakeEMRPeriod(%CLINICALDATE%) |
| ├ facilityType | LOCNAME | MakeTextConcept(%SITE%) |
| └ sourcePatientInfo | PID | MakeReference("PERSON",%PID%,"Patient") |