DocumentReference |
Top Previous Next |
|
A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The following types of documents can be searched for using the type search parameter: •11488-4 (Consultation Note) •18842-5 (Discharge Summary Note) •34117-2 (History & Physical) •28570-0 (Procedure Note) •11506-3 (Progress Note)
The following are also available via reference: •Imaging Narrative •Laboratory Report Narrative •Pathology Report Narrative
Response Description Sample Response { "resourceType": "DocumentReference", "id": "DEV-DEV-11913-D10692", "meta": { "lastUpdated": "2022-10-25T12:00:00-04:00", "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ] }, "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table><tbody><tr><td>Patient:</td><td>Cole Andersonian, Sr. (DEV-DEV-11913)</td></tr><tr><td>Document#:</td><td>D10692</td></tr><tr><td>Accession#:</td><td>0014797</td></tr><tr><td>Author:</td><td>Steven Aspen, M. D. (117)</td></tr><tr><td>Clinical Date:</td><td>11/07/2022 17:33:00.000</td></tr><tr><td>Description:</td><td>Lower Extremities: consult</td></tr></tbody></table></div>" }, "identifier": [ { "system": "https://pai.healthcare", "value": "D10692" } ], "status": "current", "type": { "coding": [ { "system": "http://loinc.org", "code": "11488-4", "display": "Consultation Note" } ], "text": "Consultation Note" }, "date": "2022-10-25T12:00:00-04:00", "subject": { "reference": "Patient/DEV-DEV-11913", "display": "Cole Andersonian, Sr. (DEV-DEV-11913)" }, "author": [ { "reference": "Practitioner/117", "display": "Steven Aspen, M. D." } ], "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ] } ], "custodian": { "reference": "Organization/DEV-DEV-PRACTICE" }, "description": "Lower Extremities: consult", "context": { "encounter": [ { "reference": "Encounter/DEV-DEV-11913-0014797", "display": "11/07/2022 at 9:30 am, MRI L/Knee with provider 117 at location OF1" } ], "period": { "start": "2022-11-07", "end": "2022-11-07" } }, "content": [ { "attachment": { "contentType": "application/msword", "data": {base64 encoded data} }, "format": { "system": "urn:oid:1.3.6.1.4.1.19376.1.2.3", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ] }
DocumentReference.id
The logical ID of the resource, as used in the URL for the resource. Once assigned, this value never changes.
DocumentReference.meta
Metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
DocumentReference.text
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
DocumentReference.identifier
Identifiers associated with the document, including version independent identifiers.
DocumentReference.status
The status of the diagnostic report.
DocumentReference.type
Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note).
DocumentReference.date
When the document reference was created.
DocumentReference.subject
Who or what the document is about. The document can be about a patient or healthcare practitioner.
DocumentReference.author
Identifies who is responsible for adding the information to the document. If available, will be the provider responsible for this part of the patient's care.
DocumentReference.category:us-core
A categorization for the type of document referenced - helps for indexing and searching. Currently supports only clinical-note value.
DocumentReference.description
A description of the source document.
DocumentReference.context
The clinical context in which the document was prepared.
DocumentReference.context.encounter
Describes the clinical encounter or type of care that the document content is associated with.
DocumentReference.context.period
Time of service that is being documented.
DocumentReference.content
The document and format referenced. There may be multiple content element repetitions, each with a different format.
DocumentReference.content.attachment
The document along with critical metadata to prove content has integrity.
DocumentReference.content.attachment.contentType
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.
DocumentReference.content.attachment.data
Data inline, base64ed.
DocumentReference.content.attachment.url
Uri where the data can be found.
Search
URL SyntaxTwo HTTP methods are supported for searching: GET and POST. It is recommended to use HTTP POST. Visit the FHIR Sandbox to try requests.
HTTP GET - searching https://sandbox.pai.healthcare/preview/fhir/DocumentReference?{query string}
HTTP GET - return single record https://sandbox.pai.healthcare/preview/fhir/DocumentReference/{resource id}
HTTP POST - searching https://sandbox.pai.healthcare/preview/fhir/DocumentReference/_search •Set the Content-Type header to application/x-www-urlencoded •The body of the request is a similar query string used in the GET type of request detailed above.
Error HandlingIf no records are returned or invalid search parameters are provided, then an HTTP 400 Bad Request is returned. The body of the response will be an OperationOutcome.
Supported Search Parameters
_id
patient
type
category
date
|