DocumentReference - FHIR v6.0.0-ballot1

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current 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

Trial Use

Security 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

Resource DocumentReference

Expression DocumentReference.attester.party

Processing Mode Normal

Target Resources Organization, RelatedPerson, PractitionerRole, Practitioner, Patient

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.17 author

Parameter author:reference

Who and/or what authored the document

Resource DocumentReference

Expression DocumentReference.author

Processing Mode Normal

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

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Resource DocumentReference

Expression DocumentReference.basedOn

Processing Mode Normal

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

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.19 bodysite

Parameter bodysite:token

The body site studied

Resource DocumentReference

Expression DocumentReference.bodySite.concept

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.20 bodysite-reference

Parameter bodysite-reference:reference

The body site studied

Resource DocumentReference

Expression DocumentReference.bodySite.reference

Processing Mode Normal

Target Resources BodyStructure

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.21 category

Parameter category:token

Categorization of document

Resource DocumentReference

Expression DocumentReference.category

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.22 contenttype

Parameter contenttype:token

Mime type of the content, with charset etc.

Resource DocumentReference

Expression DocumentReference.content.attachment.contentType

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.23 context

Parameter context:reference

Context of the document content

Resource DocumentReference

Expression DocumentReference.context

Processing Mode Normal

Target Resources Appointment, Encounter, EpisodeOfCare

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.24 creation

Parameter creation:date

Date attachment was first created

Resource DocumentReference

Expression DocumentReference.content.attachment.creation

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

Comparators Allowed: 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

Resource DocumentReference

Expression DocumentReference.custodian

Processing Mode Normal

Target Resources Organization

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Resource DocumentReference

Expression DocumentReference.date

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

Comparators Allowed: 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

Resource DocumentReference

Expression DocumentReference.description

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.28 doc-status

Parameter doc-status:token

preliminary | final | amended | entered-in-error

Resource DocumentReference

Expression DocumentReference.docStatus

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.29 event-code

Parameter event-code:token

Main clinical acts documented

Resource DocumentReference

Expression DocumentReference.event.concept

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.30 event-reference

Parameter event-reference:reference

Main clinical acts documented

Resource DocumentReference

Expression DocumentReference.event.reference

Processing Mode Normal

Target Resources Account, ActivityDefinition, ActorDefinition, AdministrableProductDefinition, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, ArtifactAssessment, AuditEvent, Basic, Binary, BiologicallyDerivedProduct, BiologicallyDerivedProductDispense, BodyStructure, Bundle, CapabilityStatement, CarePlan, CareTeam, ChargeItem, ChargeItemDefinition, Citation, Claim, ClaimResponse, ClinicalImpression, ClinicalUseDefinition, CodeSystem, Communication, CommunicationRequest, CompartmentDefinition, Composition, ConceptMap, Condition, ConditionDefinition, Consent, Contract, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, DetectedIssue, Device, DeviceAssociation, DeviceDefinition, DeviceDispense, DeviceMetric, DeviceRequest, DeviceUsage, DiagnosticReport, DocumentReference, Encounter, EncounterHistory, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, ExampleScenario, ExplanationOfBenefit, FamilyMemberHistory, Flag, FormularyItem, GenomicStudy, Goal, GraphDefinition, Group, GuidanceResponse, HealthcareService, ImagingSelection, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, ImplementationGuide, Ingredient, InsurancePlan, InventoryItem, InventoryReport, Invoice, Library, Linkage, List, Location, ManufacturedItemDefinition, Measure, MeasureReport, Medication, MedicationAdministration, MedicationDispense, MedicationKnowledge, MedicationRequest, MedicationStatement, MedicinalProductDefinition, MessageDefinition, MessageHeader, MolecularSequence, NamingSystem, NutritionIntake, NutritionOrder, NutritionProduct, Observation, ObservationDefinition, OperationDefinition, OperationOutcome, Organization, OrganizationAffiliation, PackagedProductDefinition, Parameters, Patient, PaymentNotice, PaymentReconciliation, Permission, Person, PlanDefinition, Practitioner, PractitionerRole, Procedure, Provenance, Questionnaire, QuestionnaireResponse, RegulatedAuthorization, RelatedPerson, RequestOrchestration, Requirements, ResearchStudy, ResearchSubject, RiskAssessment, Schedule, SearchParameter, ServiceRequest, Slot, Specimen, SpecimenDefinition, StructureDefinition, StructureMap, Subscription, SubscriptionStatus, SubscriptionTopic, Substance, SubstanceDefinition, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SupplyDelivery, SupplyRequest, Task, TerminologyCapabilities, TestPlan, TestReport, TestScript, Transport, ValueSet, VerificationResult, VisionPrescription

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.31 facility

Parameter facility:token

Kind of facility where patient was seen

Resource DocumentReference

Expression DocumentReference.facilityType

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.32 format-canonical

Parameter format-canonical:reference

Profile canonical content rules for the document

Resource DocumentReference

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

Processing Mode Normal

Target Resources ActivityDefinition, ActorDefinition, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, CompartmentDefinition, Composition, ConceptMap, ConditionDefinition, Contract, Device, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, ExampleScenario, GraphDefinition, Group, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, ObservationDefinition, OperationDefinition, PlanDefinition, Questionnaire, Requirements, ResearchStudy, SearchParameter, SpecimenDefinition, StructureDefinition, StructureMap, SubscriptionTopic, TerminologyCapabilities, TestPlan, TestScript, ValueSet

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.33 format-code

Parameter format-code:token

Format code content rules for the document

Resource DocumentReference

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

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.34 format-uri

Parameter format-uri:uri

Profile URI content rules for the document

Resource DocumentReference

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

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Resource DocumentReference

Expression DocumentReference.identifier

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.36 language

Parameter language:token

Human language of the content (BCP-47)

Resource DocumentReference

Expression DocumentReference.content.attachment.language

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.37 location

Parameter location:uri

Uri where the data can be found

Resource DocumentReference

Expression DocumentReference.content.attachment.url

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.38 modality

Parameter modality:token

The modality used

Resource DocumentReference

Expression DocumentReference.modality

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Resource DocumentReference

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

Processing Mode Normal

Target Resources Patient

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.40 period

Parameter period:date

Time of service that is being documented

Resource DocumentReference

Expression DocumentReference.period

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

Comparators Allowed: 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

Resource DocumentReference

Expression DocumentReference.relatesTo.target

Processing Mode Normal

Target Resources DocumentReference

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.42 relation

Parameter relation:token

replaces | transforms | signs | appends

Resource DocumentReference

Expression DocumentReference.relatesTo.code

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.43 relationship

Parameter relationship:composite

Combination of relation and relatesTo

Resource DocumentReference

Expression DocumentReference.relatesTo

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: The parameter may only have one value (no comma separators)

Components

relatesto code

relation target

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

10.2.44 security-label

Parameter security-label:token

Document security-tags

Resource DocumentReference

Expression DocumentReference.securityLabel

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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)

Resource DocumentReference

Expression DocumentReference.practiceSetting

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.46 status

Parameter status:token

current | superseded | entered-in-error

Resource DocumentReference

Expression DocumentReference.status

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.47 subject

Parameter subject:reference

Who/what is the subject of the document

Resource DocumentReference

Expression DocumentReference.subject

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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)

Resource DocumentReference

Expression DocumentReference.type

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

10.2.49 version

Parameter version:string

The business version identifier

Resource DocumentReference

Expression DocumentReference.version

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true