DocumentReference - FHIR v5.0.0-snapshot3

Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

10.2.15 Resource DocumentReference - Search Parameters

Orders and Observations icon

Work Group

Maturity Level: N/A

Standards Status: Informative

Security Category: Not Classified

Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

Search Parameter Registry for the documentreference resource

10.2.16 Search Parameters

Search parameter list for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/DocumentReference-attester

10.2.17 attester

Parameter attester:reference

Who attested the document

Resource DocumentReference

Expression DocumentReference.attester.party

Target Resources Practitioner, Organization, Patient, PractitionerRole, RelatedPerson

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-author

10.2.18 author

Parameter author:reference

Who and/or what authored the document

Resource DocumentReference

Expression DocumentReference.author

Target Resources Practitioner, Organization, CareTeam, Device, Patient, PractitionerRole, RelatedPerson

Multiples The parameter cannot repeat or have multiple values

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

10.2.19 based-on

Parameter based-on:reference

Procedure that caused this media to be created

Resource DocumentReference

Expression DocumentReference.basedOn

Target Resources Appointment, MedicationRequest, RequestOrchestration, VisionPrescription, ServiceRequest, SupplyRequest, AppointmentResponse, CoverageEligibilityRequest, CarePlan, EnrollmentRequest, EpisodeOfCare, NutritionOrder, DeviceRequest, Contract, Claim, CommunicationRequest, ImmunizationRecommendation

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-category

10.2.20 category

Parameter category:token

Categorization of document

Resource DocumentReference

Expression DocumentReference.category

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype

10.2.21 contenttype

Parameter contenttype:token

Mime type of the content, with charset etc.

Resource DocumentReference

Expression DocumentReference.content.attachment.contentType

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-context

10.2.22 context

Parameter context:reference

Context of the document content

Resource DocumentReference

Expression DocumentReference.context

Target Resources Appointment, EpisodeOfCare, Encounter

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-creation

10.2.23 creation

Parameter creation:date

Date attachment was first created

Resource DocumentReference

Expression DocumentReference.content.attachment.creation

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/DocumentReference-custodian

10.2.24 custodian

Parameter custodian:reference

Organization which maintains the document

Resource DocumentReference

Expression DocumentReference.custodian

Target Resources Organization

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-date

10.2.25 date

Parameter date:date

When this document reference was created

Resource DocumentReference

Expression DocumentReference.date

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/DocumentReference-description

10.2.26 description

Parameter description:string

Human-readable description

Resource DocumentReference

Expression DocumentReference.description

Multiples The parameter cannot repeat or have multiple values

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

10.2.27 doc-status

Parameter doc-status:token

preliminary | final | amended | entered-in-error

Resource DocumentReference

Expression DocumentReference.docStatus

Multiples The parameter cannot repeat or have multiple values

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

10.2.28 event-code

Parameter event-code:token

Main clinical acts documented

Resource DocumentReference

Expression DocumentReference.event.concept

Multiples The parameter cannot repeat or have multiple values

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

10.2.29 event-reference

Parameter event-reference:reference

Main clinical acts documented

Resource DocumentReference

Expression DocumentReference.event.reference

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-facility

10.2.30 facility

Parameter facility:token

Kind of facility where patient was seen

Resource DocumentReference

Expression DocumentReference.facilityType

Multiples The parameter cannot repeat or have multiple values

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

10.2.31 format-canonical

Parameter format-canonical:reference

Profile canonical content rules for the document

Resource DocumentReference

Expression (DocumentReference.content.profile.value as canonical)

Multiples The parameter cannot repeat or have multiple values

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

10.2.32 format-code

Parameter format-code:token

Format code content rules for the document

Resource DocumentReference

Expression (DocumentReference.content.profile.value as Coding)

Multiples The parameter cannot repeat or have multiple values

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

10.2.33 format-uri

Parameter format-uri:uri

Profile URI content rules for the document

Resource DocumentReference

Expression (DocumentReference.content.profile.value as uri)

Multiples The parameter cannot repeat or have multiple values

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

10.2.34 identifier

Parameter identifier:token

Identifier of the attachment binary

Resources

Expression DocumentReference.identifier

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-language

10.2.35 language

Parameter language:token

Human language of the content (BCP-47)

Resource DocumentReference

Expression DocumentReference.content.attachment.language

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-location

10.2.36 location

Parameter location:uri

Uri where the data can be found

Resource DocumentReference

Expression DocumentReference.content.attachment.url

Multiples The parameter cannot repeat or have multiple values

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

10.2.37 patient

Parameter patient:reference

Who/what is the subject of the document

Resources

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

Usage Normal

Target Resources Patient

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-period

10.2.38 period

Parameter period:date

Time of service that is being documented

Resource DocumentReference

Expression DocumentReference.period

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/DocumentReference-relatesto

10.2.39 relatesto

Parameter relatesto:reference

Target of the relationship

Resource DocumentReference

Expression DocumentReference.relatesTo.target

Target Resources DocumentReference

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-relation

10.2.40 relation

Parameter relation:token

replaces | transforms | signs | appends

Resource DocumentReference

Expression DocumentReference.relatesTo.code

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-relationship

10.2.41 relationship

Parameter relationship:composite

Combination of relation and relatesTo

Resource DocumentReference

Expression DocumentReference.relatesTo

Multiples The parameter cannot repeat or have multiple values

Components

relatesto code

relation target

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

10.2.42 security-label

Parameter security-label:token

Document security-tags

Resource DocumentReference

Expression DocumentReference.securityLabel

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-setting

10.2.43 setting

Parameter setting:token

Additional details about where the content was created (e.g. clinical specialty)

Resource DocumentReference

Expression DocumentReference.practiceSetting

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-status

10.2.44 status

Parameter status:token

current | superseded | entered-in-error

Resource DocumentReference

Expression DocumentReference.status

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/DocumentReference-subject

10.2.45 subject

Parameter subject:reference

Who/what is the subject of the document

Resource DocumentReference

Expression DocumentReference.subject

Target Resources All Resources

Multiples The parameter cannot repeat or have multiple values

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

10.2.46 type

Parameter type:token

Kind of document (LOINC if possible)

Resources

Expression DocumentReference.type

Usage Normal

Multiples The parameter cannot repeat or have multiple values