Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon

10.2.15 10.2.14 Resource DocumentReference - Search Parameters

Maturity Level : N/A
Responsible Owner: Orders and Observations icon Work Group   Trial Use Normative Security Category : Not Classified Compartments : Device , Encounter , Group , 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 Generated Narrative: SearchParameter DocumentReference-attester

10.2.15 attester

Parameter attester : reference

Who attested the document

Resource DocumentReference
Expression DocumentReference.attester.party
Processing Mode Normal
Target Resources Organization , RelatedPerson , PractitionerRole , Practitioner , Group , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-author

10.2.16 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 , Group , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-based-on

10.2.17 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 http://hl7.org/fhir/SearchParameter/DocumentReference-body-structure

10.2.19 Generated Narrative: SearchParameter DocumentReference-body-structure

10.2.18 bodysite body-structure

Parameter bodysite body-structure : token

The body site structure studied

Resource DocumentReference
Expression DocumentReference.bodySite.concept DocumentReference.bodyStructure.concept
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 http://hl7.org/fhir/SearchParameter/DocumentReference-body-structure-reference

10.2.20 Generated Narrative: SearchParameter DocumentReference-body-structure-reference

10.2.19 bodysite-reference body-structure-reference

Parameter bodysite-reference body-structure-reference : reference

The body site structure studied

Resource DocumentReference
Expression DocumentReference.bodySite.reference DocumentReference.bodyStructure.reference
Processing Mode Normal
Target Resources BodyStructure
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-category

10.2.20 category

Parameter category : token

Categorization of document

Resource DocumentReference
Expression DocumentReference.category
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: 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
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-context

10.2.22 context

Parameter context : reference

Context of the document content

Resource DocumentReference
Expression DocumentReference.context
Processing Mode Normal
Target Resources Appointment , Encounter , EpisodeOfCare
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-creation

10.2.23 creation

Parameter creation : date

Date attachment was first created

Resource DocumentReference
Expression DocumentReference.content.attachment.creation
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-custodian

10.2.24 custodian

Parameter custodian : reference

Organization which maintains the document

Resource DocumentReference
Expression DocumentReference.custodian
Processing Mode Normal
Target Resources Organization
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter clinical-date

10.2.25 date

Parameter date : date

DocumentReference : When this document reference was created

Resource DocumentReference
Expression DocumentReference.date
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-description

10.2.26 description

Parameter description : string

Human-readable description

Resource DocumentReference
Expression DocumentReference.description
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-doc-status

10.2.27 doc-status

Parameter doc-status : token

preliminary | final | amended | entered-in-error

Resource DocumentReference
Expression DocumentReference.docStatus
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-event-code

10.2.28 event-code

Parameter event-code : token

Main clinical acts documented

Resource DocumentReference
Expression DocumentReference.event.concept
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-event-reference

10.2.29 event-reference

Parameter event-reference : reference

Main clinical acts documented

Resource DocumentReference
Expression DocumentReference.event.reference
Processing Mode Normal
Target Resources All Resources
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-facility

10.2.30 facility

Parameter facility : token

Kind of facility where patient was seen

Resource DocumentReference
Expression DocumentReference.facilityType
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-format-canonical

10.2.31 format-canonical

Parameter format-canonical : reference uri

Profile canonical content rules for the document

Resource DocumentReference
Expression (DocumentReference.content.profile.value.ofType(canonical))
Processing Mode Normal
Target Resources Multiples ActivityDefinition , 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 Multiples
    The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: 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.ofType(Coding))
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: 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.ofType(uri))
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter clinical-identifier

10.2.34 identifier

Parameter identifier : token

DocumentReference : Identifier of the attachment binary

Resource DocumentReference
Expression DocumentReference.identifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-language

10.2.35 language

Parameter language : token

Human language of the content (BCP-47)

Resource DocumentReference
Expression DocumentReference.content.attachment.language
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-location

10.2.36 location

Parameter location : uri

Uri where the data can be found

Resource DocumentReference
Expression DocumentReference.content.attachment.url
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-modality

10.2.37 modality

Parameter modality : token

The modality used

Resource DocumentReference
Expression DocumentReference.modality
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter clinical-patient

10.2.38 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter DocumentReference-period

10.2.39 period

Parameter period : date

Time of service that is being documented

Resource DocumentReference
Expression DocumentReference.period
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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-related

Generated Narrative: SearchParameter DocumentReference-related

10.2.40 related

Parameter related : reference

Related identifiers or resources

Resource DocumentReference
Expression DocumentReference.related
Processing Mode Normal
Target Resources All Resources
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-relatesto

Generated Narrative: 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter DocumentReference-relation

10.2.42 relation

Parameter relation : token

replaces | transforms | signs | appends

Resource DocumentReference
Expression DocumentReference.relatesTo.code
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter DocumentReference-relationship

10.2.43 relationship

Parameter relationship : composite

Combination of relation and relatesTo

Resource DocumentReference
Expression DocumentReference.relatesTo
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components Comparators

relatesto code target
relation target code
 
http://hl7.org/fhir/SearchParameter/DocumentReference-security-label

Generated Narrative: 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter DocumentReference-status

10.2.46 status

Parameter status : token

current | superseded | entered-in-error

Resource DocumentReference
Expression DocumentReference.status
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: 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
Target Resources All Resources
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter DocumentReference-version

10.2.49 version

Parameter version : string

The business version identifier

Resource DocumentReference
Expression DocumentReference.version
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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