Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). 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 GroupMaturity Level: N/A  Trial UseSecurity Category: Not Classified Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

Search parameters for the Resource DocumentReference - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to 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.16 attester

Parameter attester:reference

Who attested the document

ResourceDocumentReference
ExpressionDocumentReference.attester.party
Processing ModeNormal
Target ResourcesOrganization, RelatedPerson, PractitionerRole, Practitioner, Patient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-author

10.2.17 author

Parameter author:reference

Who and/or what authored the document

ResourceDocumentReference
ExpressionDocumentReference.author
Processing ModeNormal
Target ResourcesOrganization, Device, CareTeam, RelatedPerson, PractitionerRole, Practitioner, Patient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-based-on

10.2.18 based-on

Parameter based-on:reference

Procedure that caused this media to be created

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

10.2.19 bodysite

Parameter bodysite:token

The body site studied

ResourceDocumentReference
ExpressionDocumentReference.bodySite.concept
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-bodysite-reference

10.2.20 bodysite-reference

Parameter bodysite-reference:reference

The body site studied

ResourceDocumentReference
ExpressionDocumentReference.bodySite.reference
Processing ModeNormal
Target ResourcesBodyStructure
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-category

10.2.21 category

Parameter category:token

Categorization of document

ResourceDocumentReference
ExpressionDocumentReference.category
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype

10.2.22 contenttype

Parameter contenttype:token

Mime type of the content, with charset etc.

ResourceDocumentReference
ExpressionDocumentReference.content.attachment.contentType
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-context

10.2.23 context

Parameter context:reference

Context of the document content

ResourceDocumentReference
ExpressionDocumentReference.context
Processing ModeNormal
Target ResourcesAppointment, Encounter, EpisodeOfCare
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-creation

10.2.24 creation

Parameter creation:date

Date attachment was first created

ResourceDocumentReference
ExpressionDocumentReference.content.attachment.creation
Processing ModeNormal
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.25 custodian

Parameter custodian:reference

Organization which maintains the document

ResourceDocumentReference
ExpressionDocumentReference.custodian
Processing ModeNormal
Target ResourcesOrganization
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-date
This search parameter is part of the common search parameter clinical-date

10.2.26 date

Parameter date:date

DocumentReference: When this document reference was created

ResourceDocumentReference
ExpressionDocumentReference.date
Processing ModeNormal
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.27 description

Parameter description:string

Human-readable description

ResourceDocumentReference
ExpressionDocumentReference.description
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-doc-status

10.2.28 doc-status

Parameter doc-status:token

preliminary | final | amended | entered-in-error

ResourceDocumentReference
ExpressionDocumentReference.docStatus
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-event-code

10.2.29 event-code

Parameter event-code:token

Main clinical acts documented

ResourceDocumentReference
ExpressionDocumentReference.event.concept
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-event-reference

10.2.30 event-reference

Parameter event-reference:reference

Main clinical acts documented

ResourceDocumentReference
ExpressionDocumentReference.event.reference
Processing ModeNormal
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-facility

10.2.31 facility

Parameter facility:token

Kind of facility where patient was seen

ResourceDocumentReference
ExpressionDocumentReference.facilityType
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-format-canonical

10.2.32 format-canonical

Parameter format-canonical:reference

Profile canonical content rules for the document

ResourceDocumentReference
Expression(DocumentReference.content.profile.value.ofType(canonical))
Processing ModeNormal
Target ResourcesActivityDefinition, ActorDefinition, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, CompartmentDefinition, Composition, ConceptMap, ConditionDefinition, Contract, Device, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, ExampleScenario, GraphDefinition, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, ObservationDefinition, OperationDefinition, PlanDefinition, Questionnaire, Requirements, ResearchStudy, SearchParameter, SpecimenDefinition, StructureDefinition, StructureMap, SubscriptionTopic, TerminologyCapabilities, TestPlan, TestScript, ValueSet
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-format-code

10.2.33 format-code

Parameter format-code:token

Format code content rules for the document

ResourceDocumentReference
Expression(DocumentReference.content.profile.value.ofType(Coding))
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-format-uri

10.2.34 format-uri

Parameter format-uri:uri

Profile URI content rules for the document

ResourceDocumentReference
Expression(DocumentReference.content.profile.value.ofType(uri))
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

10.2.35 identifier

Parameter identifier:token

DocumentReference: Identifier of the attachment binary

ResourceDocumentReference
ExpressionDocumentReference.identifier
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-language

10.2.36 language

Parameter language:token

Human language of the content (BCP-47)

ResourceDocumentReference
ExpressionDocumentReference.content.attachment.language
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-location

10.2.37 location

Parameter location:uri

Uri where the data can be found

ResourceDocumentReference
ExpressionDocumentReference.content.attachment.url
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-modality

10.2.38 modality

Parameter modality:token

The modality used

ResourceDocumentReference
ExpressionDocumentReference.modality
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the common search parameter clinical-patient

10.2.39 patient

Parameter patient:reference

DocumentReference: Who/what is the subject of the document

ResourceDocumentReference
ExpressionDocumentReference.subject.where(resolve() is Patient)
Processing ModeNormal
Target ResourcesPatient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-period

10.2.40 period

Parameter period:date

Time of service that is being documented

ResourceDocumentReference
ExpressionDocumentReference.period
Processing ModeNormal
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.41 relatesto

Parameter relatesto:reference

Target of the relationship

ResourceDocumentReference
ExpressionDocumentReference.relatesTo.target
Processing ModeNormal
Target ResourcesDocumentReference
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-relation

10.2.42 relation

Parameter relation:token

replaces | transforms | signs | appends

ResourceDocumentReference
ExpressionDocumentReference.relatesTo.code
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-relationship

10.2.43 relationship

Parameter relationship:composite

Combination of relation and relatesTo

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

Components

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

10.2.44 security-label

Parameter security-label:token

Document security-tags

ResourceDocumentReference
ExpressionDocumentReference.securityLabel
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-setting

10.2.45 setting

Parameter setting:token

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

ResourceDocumentReference
ExpressionDocumentReference.practiceSetting
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-status

10.2.46 status

Parameter status:token

current | superseded | entered-in-error

ResourceDocumentReference
ExpressionDocumentReference.status
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-subject

10.2.47 subject

Parameter subject:reference

Who/what is the subject of the document

ResourceDocumentReference
ExpressionDocumentReference.subject
Processing ModeNormal
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-type
This search parameter is part of the common search parameter clinical-type

10.2.48 type

Parameter type:token

DocumentReference: Kind of document (LOINC if possible)

ResourceDocumentReference
ExpressionDocumentReference.type
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/DocumentReference-version

10.2.49 version

Parameter version:string

The business version identifier

ResourceDocumentReference
ExpressionDocumentReference.version
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values