Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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 Work GroupMaturity Level: N/AStandards Status: InformativeSecurity 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

ResourceDocumentReference
ExpressionDocumentReference.attester.party
Target ResourcesPractitioner, Organization, Patient, PractitionerRole, RelatedPerson
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.author
Target ResourcesPractitioner, Organization, CareTeam, Device, Patient, PractitionerRole, RelatedPerson
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.basedOn
Target ResourcesAppointment, MedicationRequest, RequestOrchestration, VisionPrescription, ServiceRequest, SupplyRequest, AppointmentResponse, CoverageEligibilityRequest, CarePlan, EnrollmentRequest, EpisodeOfCare, NutritionOrder, DeviceRequest, Contract, Claim, CommunicationRequest, ImmunizationRecommendation
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-category

10.2.20 category

Parameter category:token

Categorization of document

ResourceDocumentReference
ExpressionDocumentReference.category
MultiplesThe 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.

ResourceDocumentReference
ExpressionDocumentReference.content.attachment.contentType
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.context
Target ResourcesAppointment, EpisodeOfCare, Encounter
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.content.attachment.creation
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: 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

ResourceDocumentReference
ExpressionDocumentReference.custodian
Target ResourcesOrganization
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.date
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: 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

ResourceDocumentReference
ExpressionDocumentReference.description
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.docStatus
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.event.concept
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.event.reference
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.facilityType
MultiplesThe 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

ResourceDocumentReference
Expression(DocumentReference.content.profile.value as canonical)
MultiplesThe 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

ResourceDocumentReference
Expression(DocumentReference.content.profile.value as Coding)
MultiplesThe 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

ResourceDocumentReference
Expression(DocumentReference.content.profile.value as uri)
MultiplesThe 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
ExpressionDocumentReference.identifier
UsageNormal
MultiplesThe 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)

ResourceDocumentReference
ExpressionDocumentReference.content.attachment.language
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.content.attachment.url
MultiplesThe 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
ExpressionDocumentReference.subject.where(resolve() is Patient)
UsageNormal
Target ResourcesPatient
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.period
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: 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

ResourceDocumentReference
ExpressionDocumentReference.relatesTo.target
Target ResourcesDocumentReference
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.relatesTo.code
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.relatesTo
MultiplesThe parameter cannot repeat or have multiple values

Components

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

10.2.42 security-label

Parameter security-label:token

Document security-tags

ResourceDocumentReference
ExpressionDocumentReference.securityLabel
MultiplesThe 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)

ResourceDocumentReference
ExpressionDocumentReference.practiceSetting
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.status
MultiplesThe 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

ResourceDocumentReference
ExpressionDocumentReference.subject
Target ResourcesAll Resources
MultiplesThe 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
ExpressionDocumentReference.type
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values