Search parameters for the Resource DocumentReference - Search Parameters resource. Also check the Extensions registry for search parameters
on extensions related to this resource.
http://hl7.org/fhir/SearchParameter/DocumentReference-attester 10.2.15 attester Parameter attester:reference
Who attested the document
Resource DocumentReference Expression
DocumentReference.attester.partyProcessing 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.16 author Parameter author:reference
Who and/or what authored the document
Resource DocumentReference Expression
DocumentReference.authorProcessing 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.17 based-on Parameter based-on:reference
Procedure that caused this media to be created
Resource DocumentReference Expression
DocumentReference.basedOnProcessing 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.18 bodysite Parameter bodysite:token
Resource DocumentReference Expression
DocumentReference.bodySite.conceptProcessing 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.19 bodysite-reference Parameter bodysite-reference:reference
Resource DocumentReference Expression
DocumentReference.bodySite.referenceProcessing 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.20 category Parameter category:token
Categorization of document
Resource DocumentReference Expression
DocumentReference.categoryProcessing 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.21 contenttype Parameter contenttype:token
Mime type of the content, with charset etc.
Resource DocumentReference Expression
DocumentReference.content.attachment.contentTypeProcessing 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.22 context Parameter context:reference
Context of the document content
Resource DocumentReference Expression
DocumentReference.contextProcessing 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.23 creation Parameter creation:date
Date attachment was first created
Resource DocumentReference Expression
DocumentReference.content.attachment.creationProcessing 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.24 custodian Parameter custodian:reference
Organization which maintains the document
Resource DocumentReference Expression
DocumentReference.custodianProcessing 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-dateThis search parameter is part of the common search parameter clinical-date 10.2.25 date Parameter date:date
Resource DocumentReference Expression
DocumentReference.dateProcessing 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.26 description Parameter description:string
Human-readable description
Resource DocumentReference Expression
DocumentReference.descriptionProcessing 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.27 doc-status Parameter doc-status:token
preliminary | final | amended | entered-in-error
Resource DocumentReference Expression
DocumentReference.docStatusProcessing 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.28 event-code Parameter event-code:token
Main clinical acts documented
Resource DocumentReference Expression
DocumentReference.event.conceptProcessing 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.29 event-reference Parameter event-reference:reference
Main clinical acts documented
Resource DocumentReference Expression
DocumentReference.event.referenceProcessing 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.30 facility Parameter facility:token
Kind of facility where patient was seen
Resource DocumentReference Expression
DocumentReference.facilityTypeProcessing 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.31 format-canonical Parameter format-canonical:uri
Profile canonical content rules for the document
Resource DocumentReference Expression
(DocumentReference.content.profile.value.ofType(canonical))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-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
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.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
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-identifierThis search parameter is part of the common search parameter clinical-identifier 10.2.34 identifier Parameter identifier:token
Resource DocumentReference Expression
DocumentReference.identifierProcessing 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.35 language Parameter language:token
Human language of the content (BCP-47)
Resource DocumentReference Expression
DocumentReference.content.attachment.languageProcessing 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.36 location Parameter location:uri
Uri where the data can be found
Resource DocumentReference Expression
DocumentReference.content.attachment.urlProcessing 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.37 modality Parameter modality:token
Resource DocumentReference Expression
DocumentReference.modalityProcessing 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-patientThis search parameter is part of the common search parameter clinical-patient 10.2.38 patient Parameter patient:reference
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.39 period Parameter period:date
Time of service that is being documented
Resource DocumentReference Expression
DocumentReference.periodProcessing 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-related 10.2.40 related Parameter related:reference
Related identifiers or resources
Resource DocumentReference Expression
DocumentReference.relatedProcessing 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-relatesto 10.2.41 relatesto Parameter relatesto:reference
Target of the relationship
Resource DocumentReference Expression
DocumentReference.relatesTo.targetProcessing 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.codeProcessing 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.relatesToProcessing 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)
Comparators
http://hl7.org/fhir/SearchParameter/DocumentReference-security-label 10.2.44 security-label Parameter security-label:token
Resource DocumentReference Expression
DocumentReference.securityLabelProcessing 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.practiceSettingProcessing 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.statusProcessing 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.subjectProcessing 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/clinical-typeThis search parameter is part of the common search parameter clinical-type 10.2.48 type Parameter type:token
Resource DocumentReference Expression
DocumentReference.typeProcessing 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.versionProcessing 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
Diagnostics
Work Group
|
Propose a change