---
type: "search-params"
title: "DocumentReference Search Parameters"
resource: "DocumentReference"
---
# DocumentReference Search Parameters

<a id="attester"></a>

## attester
**Description:** Who attested the document

**Type:** reference

**Expression:** DocumentReference.attester.party

**Path:** DocumentReference.attester.party

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-attester


<a id="author"></a>

## author
**Description:** Who and/or what authored the document

**Type:** reference

**Expression:** DocumentReference.author

**Path:** DocumentReference.author

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-author


<a id="based-on"></a>

## based-on
**Description:** Procedure that caused this media to be created

**Type:** reference

**Expression:** DocumentReference.basedOn

**Path:** DocumentReference.basedOn

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-based-on


<a id="category"></a>

## category
**Description:** Categorization of document

**Type:** token

**Expression:** DocumentReference.category

**Path:** DocumentReference.category

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-category


<a id="contenttype"></a>

## contenttype
**Description:** Mime type of the content, with charset etc.

**Type:** token

**Expression:** DocumentReference.content.attachment.contentType

**Path:** DocumentReference.content.attachment.contentType

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-contenttype


<a id="creation"></a>

## creation
**Description:** Date attachment was first created

**Type:** date

**Expression:** DocumentReference.content.attachment.creation

**Path:** DocumentReference.content.attachment.creation

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-creation


<a id="custodian"></a>

## custodian
**Description:** Organization which maintains the document

**Type:** reference

**Expression:** DocumentReference.custodian

**Path:** DocumentReference.custodian

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-custodian


<a id="date"></a>

## date
**Description:** When this document reference was created

**Type:** date

**Expression:** DocumentReference.date

**Path:** DocumentReference.date

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-date


<a id="description"></a>

## description
**Description:** Human-readable description

**Type:** string

**Expression:** DocumentReference.description

**Path:** DocumentReference.description

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-description


<a id="doc-status"></a>

## doc-status
**Description:** preliminary | final | amended | entered-in-error

**Type:** token

**Expression:** DocumentReference.docStatus

**Path:** DocumentReference.docStatus

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-doc-status


<a id="context"></a>

## context
**Description:** Context of the document content

**Type:** reference

**Expression:** DocumentReference.context

**Path:** DocumentReference.context

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-context


<a id="event-code"></a>

## event-code
**Description:** Main clinical acts documented

**Type:** token

**Expression:** DocumentReference.event.concept

**Path:** DocumentReference.event.concept

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-event-code


<a id="event-reference"></a>

## event-reference
**Description:** Main clinical acts documented

**Type:** reference

**Expression:** DocumentReference.event.reference

**Path:** DocumentReference.event.reference

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-event-reference


<a id="facility"></a>

## facility
**Description:** Kind of facility where patient was seen

**Type:** token

**Expression:** DocumentReference.facilityType

**Path:** DocumentReference.facilityType

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-facility


<a id="format-code"></a>

## format-code
**Description:** Format code content rules for the document

**Type:** token

**Expression:** (DocumentReference.content.profile.value.ofType(Coding))

**Path:** DocumentReference.content.profile.valueCoding

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-format-code


<a id="format-uri"></a>

## format-uri
**Description:** Profile URI content rules for the document

**Type:** uri

**Expression:** (DocumentReference.content.profile.value.ofType(uri))

**Path:** DocumentReference.content.profile.valueUri

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-format-uri


<a id="format-canonical"></a>

## format-canonical
**Description:** Profile canonical content rules for the document

**Type:** uri

**Expression:** (DocumentReference.content.profile.value.ofType(canonical))

**Path:** DocumentReference.content.profile.valueCanonical

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-format-canonical


<a id="identifier"></a>

## identifier
**Description:** Identifier of the attachment binary

**Type:** token

**Expression:** DocumentReference.identifier

**Path:** DocumentReference.identifier

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-identifier


<a id="language"></a>

## language
**Description:** Human language of the content (BCP-47)

**Type:** token

**Expression:** DocumentReference.content.attachment.language

**Path:** DocumentReference.content.attachment.language

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-language


<a id="location"></a>

## location
**Description:** Uri where the data can be found

**Type:** uri

**Expression:** DocumentReference.content.attachment.url

**Path:** DocumentReference.content.attachment.url

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-location


<a id="patient"></a>

## patient
**Description:** Who/what is the subject of the document

**Type:** reference

**Expression:** DocumentReference.subject.where(resolve() is Patient)

**Path:** DocumentReference.subject

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-patient


<a id="period"></a>

## period
**Description:** Time of service that is being documented

**Type:** date

**Expression:** DocumentReference.period

**Path:** DocumentReference.period

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-period


<a id="relatesto"></a>

## relatesto
**Description:** Target of the relationship

**Type:** reference

**Expression:** DocumentReference.relatesTo.target

**Path:** DocumentReference.relatesTo.target

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-relatesto


<a id="relation"></a>

## relation
**Description:** replaces | transforms | signs | appends

**Type:** token

**Expression:** DocumentReference.relatesTo.code

**Path:** DocumentReference.relatesTo.code

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-relation


<a id="relationship"></a>

## relationship
**Description:** Combination of relation and relatesTo

**Type:** composite

**Expression:** DocumentReference.relatesTo

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-relationship


<a id="security-label"></a>

## security-label
**Description:** Document security-tags

**Type:** token

**Expression:** DocumentReference.securityLabel

**Path:** DocumentReference.securityLabel

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-security-label


<a id="setting"></a>

## setting
**Description:** Additional details about where the content was created (e.g. clinical specialty)

**Type:** token

**Expression:** DocumentReference.practiceSetting

**Path:** DocumentReference.practiceSetting

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-setting


<a id="status"></a>

## status
**Description:** current | superseded | entered-in-error

**Type:** token

**Expression:** DocumentReference.status

**Path:** DocumentReference.status

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-status


<a id="subject"></a>

## subject
**Description:** Who/what is the subject of the document

**Type:** reference

**Expression:** DocumentReference.subject

**Path:** DocumentReference.subject

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-subject


<a id="type"></a>

## type
**Description:** Kind of document (LOINC if possible)

**Type:** token

**Expression:** DocumentReference.type

**Path:** DocumentReference.type

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-type


<a id="version"></a>

## version
**Description:** The business version identifier

**Type:** string

**Expression:** DocumentReference.version

**Path:** {{name}}.version

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-version


<a id="body-structure"></a>

## body-structure
**Description:** The body structure studied

**Type:** token

**Expression:** DocumentReference.bodyStructure.concept

**Path:** {{name}}.bodyStructure.concept

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-body-structure


<a id="body-structure-reference"></a>

## body-structure-reference
**Description:** The body structure studied

**Type:** reference

**Expression:** DocumentReference.bodyStructure.reference

**Path:** {{name}}.bodyStructure.reference

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-body-structure-reference


<a id="modality"></a>

## modality
**Description:** The modality used

**Type:** token

**Expression:** DocumentReference.modality

**Path:** {{name}}.modality

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-modality


<a id="related"></a>

## related
**Description:** Related identifiers or resources

**Type:** reference

**Expression:** DocumentReference.related

**Path:** DocumentReference.related

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/DocumentReference-related