CommunicationRequest - FHIR v6.0.0-ballot3

This page is part of the FHIR Specification v6.0.0-ballot3: Release 6 Ballot (3rd Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

8.24.13 Resource CommunicationRequest - Search Parameters

Patient Care icon

Work Group

Maturity Level: N/A

Trial Use

Security Category: Patient

Compartments: Device, Encounter, Group, Patient, Practitioner, RelatedPerson

Search parameters for the CommunicationRequest 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/CommunicationRequest-about

Generated Narrative: SearchParameter CommunicationRequest-about

8.24.14 about

Parameter about:reference

Resources that pertain to this communication request

Resource CommunicationRequest

Expression CommunicationRequest.about

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, 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, 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/CommunicationRequest-authored

Generated Narrative: SearchParameter CommunicationRequest-authored

8.24.15 authored

Parameter authored:date

When request transitioned to being actionable

Resource CommunicationRequest

Expression CommunicationRequest.authoredOn

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/CommunicationRequest-based-on

Generated Narrative: SearchParameter CommunicationRequest-based-on

8.24.16 based-on

Parameter based-on:reference

Fulfills plan or proposal

Resource CommunicationRequest

Expression CommunicationRequest.basedOn

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/CommunicationRequest-category

Generated Narrative: SearchParameter CommunicationRequest-category

8.24.17 category

Parameter category:token

Message category

Resource CommunicationRequest

Expression CommunicationRequest.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/clinical-encounter

This search parameter is part of the common search parameter clinical-encounter

Generated Narrative: SearchParameter clinical-encounter

8.24.18 encounter

Parameter encounter:reference

CommunicationRequest: The Encounter during which this CommunicationRequest was created

Resource CommunicationRequest

Expression CommunicationRequest.encounter

Processing Mode Normal

Target Resources Encounter

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/CommunicationRequest-group-identifier

Generated Narrative: SearchParameter CommunicationRequest-group-identifier

8.24.19 group-identifier

Parameter group-identifier:token

Composite request this is part of

Resource CommunicationRequest

Expression CommunicationRequest.groupIdentifier

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

Generated Narrative: SearchParameter clinical-identifier

8.24.20 identifier

Parameter identifier:token

CommunicationRequest: Unique identifier

Resource CommunicationRequest

Expression CommunicationRequest.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/CommunicationRequest-information-provider

Generated Narrative: SearchParameter CommunicationRequest-information-provider

8.24.21 information-provider

Parameter information-provider:reference

Who should share the information

Resource CommunicationRequest

Expression CommunicationRequest.informationProvider

Processing Mode Normal

Target Resources HealthcareService, Device, Organization, Endpoint, RelatedPerson, PractitionerRole, Practitioner, Group, 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/CommunicationRequest-medium

Generated Narrative: SearchParameter CommunicationRequest-medium

8.24.22 medium

Parameter medium:token

A channel of communication

Resource CommunicationRequest

Expression CommunicationRequest.medium

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/CommunicationRequest-occurrence

Generated Narrative: SearchParameter CommunicationRequest-occurrence

8.24.23 occurrence

Parameter occurrence:date

When scheduled

Resource CommunicationRequest

Expression CommunicationRequest.occurrence.ofType(dateTime) | CommunicationRequest.occurrence.ofType(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/clinical-patient

This search parameter is part of the common search parameter clinical-patient

Generated Narrative: SearchParameter clinical-patient

8.24.24 patient

Parameter patient:reference

CommunicationRequest: Focus of message

Resource CommunicationRequest

Expression CommunicationRequest.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/CommunicationRequest-priority

Generated Narrative: SearchParameter CommunicationRequest-priority

8.24.25 priority

Parameter priority:token

routine | urgent | asap | stat

Resource CommunicationRequest

Expression CommunicationRequest.priority

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/CommunicationRequest-recipient

Generated Narrative: SearchParameter CommunicationRequest-recipient

8.24.26 recipient

Parameter recipient:reference

Who to share the information with

Resource CommunicationRequest

Expression CommunicationRequest.recipient

Processing Mode Normal

Target Resources HealthcareService, Device, Organization, CareTeam, Endpoint, RelatedPerson, PractitionerRole, Practitioner, Group, 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/CommunicationRequest-replaces

Generated Narrative: SearchParameter CommunicationRequest-replaces

8.24.27 replaces

Parameter replaces:reference

Request(s) replaced by this request

Resource CommunicationRequest

Expression CommunicationRequest.replaces

Processing Mode Normal

Target Resources CommunicationRequest

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/CommunicationRequest-requester

Generated Narrative: SearchParameter CommunicationRequest-requester

8.24.28 requester

Parameter requester:reference

Who asks for the information to be shared

Resource CommunicationRequest

Expression CommunicationRequest.requester

Processing Mode Normal

Target Resources Organization, Device, RelatedPerson, PractitionerRole, Practitioner, Group, 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/CommunicationRequest-status

Generated Narrative: SearchParameter CommunicationRequest-status

8.24.29 status

Parameter status:token

Resource CommunicationRequest

Expression CommunicationRequest.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/CommunicationRequest-subject

Generated Narrative: SearchParameter CommunicationRequest-subject

8.24.30 subject

Parameter subject:reference

Focus of message

Resource CommunicationRequest

Expression CommunicationRequest.subject

Processing Mode Normal

Target Resources Group, 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