DocumentReference

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.

Overview

A DocumentReference resource is used to index a document, clinical note, and other binary objects to make them available to a healthcare system. A document is some sequence of bytes that is identifiable, establishes its own context (e.g., what subject, author, etc. can be displayed to the user), and has defined update management.

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 described in the Definition and Detailed Definitions below 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.

List of profiles we support:

Definition

The official URL for this profile is:

https://fhir.athena.io/StructureDefinition/ah-documentreference

The base definition for this profile is:

DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference0..*DocumentReferenceA reference to a document
... idΣ0..1idLogical id of this artifact
... metaΣ0..1MetaMetadata about the resource
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionIdΣ0..1idVersion specific identifier
.... lastUpdatedΣ0..1instant (YYYY-MM-DDThh:mm:ss.sss+zz:zz)When the resource version last changed
.... sourceΣ0..1uriIdentifies where the resource comes from
.... profileΣ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... securityΣ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tagΣ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules?!Σ0..1uriA set of rules under which this content was created
... text0..1NarrativeText summary of the resource, for human interpretation
... contained0..*ResourceContained, inline Resources
... Slices for extension1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ahChartSharingGroup0..1Reference(Organization)athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
... ahPractice1..1Reference(Organization)athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... modifierExtension?!0..*ExtensionExtensions that cannot be ignored
... identifierΣ0..*IdentifierOther identifiers for the document
... status?!Σ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... docStatusΣ0..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.

... typeΣ0..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.

... categoryΣ0..*CodeableConceptCategorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subjectΣ0..1Reference(Patient)Who/what is the subject of the document
... dateΣ0..1instant (YYYY-MM-DDThh:mm:ss.sss+zz:zz)When this document reference was created
... authorΣ0..*Reference(Practitioner | Organization)Who and/or what authored the document
... custodian0..1Reference(Organization)Organization which maintains the document
... contentΣ1..*BackboneElementDocument referenced
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... modifierExtension?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachmentΣ1..1AttachmentWhere to access the document
.... formatΣ0..1CodingFormat/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.

... contextΣ0..1BackboneElementClinical context of document
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... modifierExtension?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... encounter0..*Reference(Encounter)Context of the document content
.... periodΣ0..1PeriodTime of service that is being documented

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DocumentReference.meta.securityextensibleAll Security Labels
DocumentReference.meta.tagexampleCommonTags
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.statusrequiredDocumentReferenceStatus
DocumentReference.docStatusrequiredCompositionStatus
DocumentReference.typepreferredDocumentTypeValueSet
DocumentReference.categoryexampleDocumentClassValueSet
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)

Detailed Definitions


DocumentReference

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 scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

Cardinality 0..*
Type Root
Comments Usually, this is used for documents other than those defined by FHIR.

DocumentReference.id

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

Cardinality 0..1
Type id
Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

DocumentReference.meta

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

Cardinality 0..1
Type Meta

DocumentReference.meta.id

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1
Type string

DocumentReference.meta.extension

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.

Cardinality 0..*
Type Extension
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DocumentReference.meta.versionId

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Cardinality 0..1
Type id
Comments The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

DocumentReference.meta.lastUpdated

When the resource last changed - e.g. when the version changed.

Cardinality 0..1
Type instant (YYYY-MM-DDThh:mm:ss.sss+zz:zz)
Comments This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

DocumentReference.meta.source

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Cardinality 0..1
Type uri
Comments In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

DocumentReference.meta.profile

A list of profiles (references to StructureDefinition.

Cardinality 0..*
Type canonical
Comments It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

DocumentReference.meta.security

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Cardinality 0..*
Type Coding Binding: All Security Labels (extensible)
Comments meta.security may contain the following: an item with code 'NOPAT' if the resource is not patient facing, and/or an item with code 'SUBSETTED' if the _query search parameter is defined.

DocumentReference.meta.tag

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Cardinality 0..*
Type Coding Binding: CommonTags (example)
Comments The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

DocumentReference.implicitRules

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Cardinality 0..1
Type uri
Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

DocumentReference.language

The base language in which the resource is written.

Cardinality 0..1
Type code Binding: CommonLanguages (preferred)
Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

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. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Cardinality 0..1
Type Narrative
Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

DocumentReference.contained

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Cardinality 0..*
Type Resource
Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

DocumentReference.extension

An Extension

Cardinality 1..*
Type Extension

DocumentReference.extension:ahChartSharingGroup

An Extension used to reference a specific athenahealth chart sharing group Organization.

Cardinality 0..1
Type Extension(AthenaChartSharingGroup)

DocumentReference.extension:ahPractice

An Extension used to reference a specific athenahealth practice Organization.

Cardinality 1..1
Type Extension(AthenaPractice)

DocumentReference.modifierExtension

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*
Type Extension
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Requirements Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

DocumentReference.identifier

Other identifiers associated with the document, including version independent identifiers.

Cardinality 0..*
Type Identifier

DocumentReference.status

The status of this document reference.

Cardinality 1..1
Type code Binding: DocumentReferenceStatus (required)
Comments This is the status of the DocumentReference object, which might be independent from the docStatus element. This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.

DocumentReference.docStatus

The status of the underlying document.

Cardinality 0..1
Type code Binding: CompositionStatus (required)
Comments The document that is pointed to might be in various lifecycle states.

DocumentReference.type

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.

Cardinality 0..1
Type CodeableConcept Binding: DocumentTypeValueSet (preferred)
Comments Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.

DocumentReference.category

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.

Cardinality 0..*
Type CodeableConcept Binding: DocumentClassValueSet (example)
Comments Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.

DocumentReference.subject

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).

Cardinality 0..1
Type Reference(Patient)

DocumentReference.date

When the document reference was created.

Cardinality 0..1
Type instant (YYYY-MM-DDThh:mm:ss.sss+zz:zz)
Comments Referencing/indexing time is used for tracking, organizing versions and searching.

DocumentReference.author

Identifies who is responsible for adding the information to the document.

Cardinality 0..*
Type Reference(Practitioner | Organization)
Comments Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).

DocumentReference.custodian

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

Cardinality 0..1
Type Reference(Organization)
Comments Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.

DocumentReference.content

The document and format referenced. There may be multiple content element repetitions, each with a different format.

Cardinality 1..*
Type BackboneElement

DocumentReference.content.id

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1
Type string

DocumentReference.content.extension

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.

Cardinality 0..*
Type Extension
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DocumentReference.content.modifierExtension

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*
Type Extension
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Requirements Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

DocumentReference.content.attachment

The document or URL of the document along with critical metadata to prove content has integrity.

Cardinality 1..1
Type Attachment

DocumentReference.content.format

An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

Cardinality 0..1
Type Coding Binding: DocumentReferenceFormatCodeSet (preferred)
Comments Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI.

DocumentReference.context

The clinical context in which the document was prepared.

Cardinality 0..1
Type BackboneElement
Comments These values are primarily added to help with searching for interesting/relevant documents.

DocumentReference.context.id

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1
Type string

DocumentReference.context.extension

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.

Cardinality 0..*
Type Extension
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DocumentReference.context.modifierExtension

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*
Type Extension
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Requirements Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

DocumentReference.context.encounter

Describes the clinical encounter or type of care that the document content is associated with.

Cardinality 0..*
Type Reference(Encounter)

DocumentReference.context.period

The time period over which the service that is described by the document was provided.

Cardinality 0..1
Type Period

Interactions

READ

Read interactions are executed as specified in the HL7 FHIR RESTful API read specification. To read DocumentReference resources, an application will perform an HTTP GET specifying the logical ID of the DocumentReference being retrieved.

The [patient|user|system]/DocumentReference.read authorization scope is required.

GET
/fhir/r4/DocumentReference/{logicalId}
Try in Postman

Parameters

required

conditional required

Name Type Description
logicalId string (REQUIRED) The logical ID of the resource (alias: Resource.id). It is specified in the URL path and not as a query parameter.

Response Codes

Response code Description
200 OK The requested DocumentReference resource was found and is contained within the body of the HTTP response.
400 Bad Request The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone The requested resource has been permanently deleted from server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx 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.

GET SEARCH

Search interactions are executed as specified in the HL7 FHIR RESTful API search specification. To search for DocumentReference resources using the HTTP GET method, an application will perform the HTTP GET specifying the query parameters associated with the DocumentReference in the URL.

The [patient|user|system]/DocumentReference.read authorization scope is required.

The following additional authorization scopes might be required depending on _include and/or _revinclude search parameters used:

  • [patient|user|system]/Device.read
  • [patient|user|system]/Encounter.read
  • [patient|user|system]/Organization.read
  • [patient|user|system]/Patient.read
  • [patient|user|system]/Practitioner.read
  • [patient|user|system]/Provenance.read

GET
/fhir/r4/DocumentReference
Try in Postman

Parameters

DocumentReference search requests conditionally require one of the following search parameters or search parameter combinations in order to match and return a result set:
  • patient
  • _id

required

conditional required

Name Type Description
ah-practice reference Identify the athenahealth Practice Organization (e.g., 'ah-practice=Organization/a-1.Practice-[practiceId]')
_id token (CONDITIONAL REQUIRED) DocumentReference.id resource reference to FHIR DocumentReference resource
patient reference (CONDITIONAL REQUIRED) DocumentReference.subject resource reference to FHIR Patient resource
_query string Custom named query
category token DocumentReference.category is the parameter for searching on category
type token DocumentReference.type is the parameter for searching on code
date date DocumentReference.date is the parameter for searching on date; May be specified for sorting.
_count number The number of DocumentReference resources to return per page for paged search results.
cursor token Search by cursor token for first resource to return in a paged search result
encounter reference DocumentReference.context.encounter resource reference to FHIR Encounter resource
author reference DocumentReference.author resource reference to the FHIR Practitioner or Organization resource
custodian reference DocumentReference.custodian resource reference to the FHIR Organization resource
_lastUpdated date Last updated parameter consists of a comparator (eq, gt, lt, ge and le) and a date (format: YYYY-MM-DD). It can be used to select document reference resources based on the last time they changed.
ah-chart-sharing-group reference Search by athenahealth Chart Sharing Group (e.g., 'ah-chart-sharing-group=Organization/a-[practiceId].CSG-[csgId]') for resources containing the 'Athena Chart Sharing Group' Extension
_include string Requests the server to include the referenced resource(s) in the search results according to the specified search parameter. Additional authorization scope(s) will be required. The supported _include parameter values are:
  • DocumentReference:ah-chart-sharing-group - Included resource(s) Organization and required scope(s) [patient|user|system]/Organization.read
  • DocumentReference:encounter - Included resource(s) Encounter and required scope(s) [patient|user|system]/Encounter.read
  • DocumentReference:patient - Included resource(s) Patient and required scope(s) [patient|user|system]/Patient.read
  • DocumentReference:author - Included resource(s) Device, Organization, Patient, Practitioner and required scope(s) [patient|user|system]/Device.read, [patient|user|system]/Organization.read, [patient|user|system]/Patient.read, [patient|user|system]/Practitioner.read
  • DocumentReference:custodian - Included resource(s) Organization and required scope(s) [patient|user|system]/Organization.read
_revinclude string Requests the server to include the associated resource(s) in the search results according to the specified search parameter. Additional authorization scope(s) will be required. The supported _revinclude parameter values are:
  • Provenance:target - Associated resource(s) Provenance and required scope(s) [patient|user|system]/Provenance.read
_sort sort Requests the server to sort the search results according to the provided search parameter(s). An optional '-' prefix indicates decreasing order; in its absence, the parameter is applied in increasing order. The supported _sort parameter values are:
  • date

Response Codes

Response code Description
200 OK The search request succeeded. The body of the HTTP response will contain a Bundle resource containing the results of the search.
403 Forbidden The server refused to perform the search due to a missing required search parameter. The body of the HTTP response will contain an OperationOutcome resource that includes the required search parameters.
500 Internal Server Error The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx 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.

POST SEARCH

Search interactions are executed as specified in the HL7 FHIR RESTful API search specification. To search for DocumentReference resources using the HTTP POST method, an application will perform the HTTP POST specifying the query parameters associated with the DocumentReference in the request body.

The [patient|user|system]/DocumentReference.read authorization scope is required.

The following additional authorization scopes might be required depending on _include and/or _revinclude search parameters used:

  • [patient|user|system]/Device.read
  • [patient|user|system]/Encounter.read
  • [patient|user|system]/Organization.read
  • [patient|user|system]/Patient.read
  • [patient|user|system]/Practitioner.read
  • [patient|user|system]/Provenance.read

POST
/fhir/r4/DocumentReference/_search
Try in Postman

Request Header

Content-Type: application/x-www-form-urlencoded

Request Body

param1=value1&param2=value2...

Parameters

DocumentReference search requests conditionally require one of the following search parameters or search parameter combinations in order to match and return a result set:
  • patient
  • _id

required

conditional required

Name Type Description
ah-practice reference Identify the athenahealth Practice Organization (e.g., 'ah-practice=Organization/a-1.Practice-[practiceId]')
_id token (CONDITIONAL REQUIRED) DocumentReference.id resource reference to FHIR DocumentReference resource
patient reference (CONDITIONAL REQUIRED) DocumentReference.subject resource reference to FHIR Patient resource
_query string Custom named query
category token DocumentReference.category is the parameter for searching on category
type token DocumentReference.type is the parameter for searching on code
date date DocumentReference.date is the parameter for searching on date; May be specified for sorting.
_count number The number of DocumentReference resources to return per page for paged search results.
cursor token Search by cursor token for first resource to return in a paged search result
encounter reference DocumentReference.context.encounter resource reference to FHIR Encounter resource
author reference DocumentReference.author resource reference to the FHIR Practitioner or Organization resource
custodian reference DocumentReference.custodian resource reference to the FHIR Organization resource
_lastUpdated date Last updated parameter consists of a comparator (eq, gt, lt, ge and le) and a date (format: YYYY-MM-DD). It can be used to select document reference resources based on the last time they changed.
ah-chart-sharing-group reference Search by athenahealth Chart Sharing Group (e.g., 'ah-chart-sharing-group=Organization/a-[practiceId].CSG-[csgId]') for resources containing the 'Athena Chart Sharing Group' Extension
_include string Requests the server to include the referenced resource(s) in the search results according to the specified search parameter. Additional authorization scope(s) will be required. The supported _include parameter values are:
  • DocumentReference:ah-chart-sharing-group - Included resource(s) Organization and required scope(s) [patient|user|system]/Organization.read
  • DocumentReference:encounter - Included resource(s) Encounter and required scope(s) [patient|user|system]/Encounter.read
  • DocumentReference:patient - Included resource(s) Patient and required scope(s) [patient|user|system]/Patient.read
  • DocumentReference:author - Included resource(s) Device, Organization, Patient, Practitioner and required scope(s) [patient|user|system]/Device.read, [patient|user|system]/Organization.read, [patient|user|system]/Patient.read, [patient|user|system]/Practitioner.read
  • DocumentReference:custodian - Included resource(s) Organization and required scope(s) [patient|user|system]/Organization.read
_revinclude string Requests the server to include the associated resource(s) in the search results according to the specified search parameter. Additional authorization scope(s) will be required. The supported _revinclude parameter values are:
  • Provenance:target - Associated resource(s) Provenance and required scope(s) [patient|user|system]/Provenance.read
_sort sort Requests the server to sort the search results according to the provided search parameter(s). An optional '-' prefix indicates decreasing order; in its absence, the parameter is applied in increasing order. The supported _sort parameter values are:
  • date

Response Codes

Response code Description
200 OK The search request succeeded. The body of the HTTP response will contain a Bundle resource containing the results of the search.
403 Forbidden The server refused to perform the search due to a missing required search parameter. The body of the HTTP response will contain an OperationOutcome resource that includes the required search parameters.
500 Internal Server Error The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx 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.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

On this Page