R6 Ballot (3rd Draft) FHIR CI-Build

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 Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.23.13 8.22.13 Resource Communication - Search Parameters

Maturity Level : N/A
Responsible Owner: Patient Care icon Work Group   Trial Use Security Category : Patient Compartments : Device , Encounter , Group , Patient , Practitioner , RelatedPerson

Search parameters for the Communication 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/Communication-based-on

Generated Narrative: SearchParameter Communication-based-on

8.23.14 8.22.14 based-on

Parameter based-on : reference

Request fulfilled by this communication

Resource Communication
Expression Communication.basedOn
Processing Mode Normal
Target Resources DeviceRequest , ServiceRequest , CarePlan , CommunicationRequest , Task , MedicationRequest , ImmunizationRecommendation , NutritionOrder , 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/Communication-category

Generated Narrative: SearchParameter Communication-category

8.23.15 8.22.15 category

Parameter category : token

Message category

Resource Communication
Expression Communication.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.23.16 8.22.16 encounter

Parameter encounter : reference

Communication : The Encounter during which this Communication was created

Resource Communication
Expression Communication.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/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

Generated Narrative: SearchParameter clinical-identifier

8.23.17 8.22.17 identifier

Parameter identifier : token

Communication : Unique identifier

Resource Communication
Expression Communication.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/Communication-in-response-to

Generated Narrative: SearchParameter Communication-in-response-to

8.23.18 8.22.18 in-response-to

Parameter in-response-to : reference

Reply to

Resource Communication
Expression Communication.inResponseTo
Processing Mode Normal
Target Resources Communication
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/Communication-medium

Generated Narrative: SearchParameter Communication-medium

8.23.19 8.22.19 medium

Parameter medium : token

A channel of communication

Resource Communication
Expression Communication.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/Communication-part-of

Generated Narrative: SearchParameter Communication-part-of

8.23.20 8.22.20 part-of

Parameter part-of : reference

Part of referenced event (e.g. Communication, Procedure)

Resource Communication
Expression Communication.partOf
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 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/clinical-patient
This search parameter is part of the common search parameter clinical-patient

Generated Narrative: SearchParameter clinical-patient

8.23.21 8.22.21 patient

Parameter patient : reference

Communication : Focus of message

Resource Communication
Expression Communication.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/Communication-reason-code

Generated Narrative: SearchParameter Communication-reason-code

8.23.22 8.22.22 reason-code

Parameter reason-code : token

Indication for the message

Resource Communication
Expression Communication.reason.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/Communication-reason-reference

Generated Narrative: SearchParameter Communication-reason-reference

8.23.23 8.22.23 reason-reference

Parameter reason-reference : reference

Indication for the message

Resource Communication
Expression Communication.reason.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 , 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 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/Communication-received

Generated Narrative: SearchParameter Communication-received

8.23.24 8.22.24 received

Parameter received : date

When received

Resource Communication
Expression Communication.received
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/Communication-recipient

Generated Narrative: SearchParameter Communication-recipient

8.23.25 8.22.25 recipient

Parameter recipient : reference

Who the information is shared with

Resource Communication
Expression Communication.recipient
Processing Mode Normal
Target Resources HealthcareService , CareTeam , Device , Organization , Endpoint , RelatedPerson , PractitionerRole , Group , Practitioner , Location , 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/Communication-sender

Generated Narrative: SearchParameter Communication-sender

8.23.26 8.22.26 sender

Parameter sender : reference

Who shares the information

Resource Communication
Expression Communication.sender
Processing Mode Normal
Target Resources HealthcareService , Device , Organization , Endpoint , 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/Communication-sent

Generated Narrative: SearchParameter Communication-sent

8.23.27 8.22.27 sent

Parameter sent : date

When sent

Resource Communication
Expression Communication.sent
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/Communication-status

Generated Narrative: SearchParameter Communication-status

8.23.28 8.22.28 status

Parameter status : token

preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown

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

Generated Narrative: SearchParameter Communication-subject

8.23.29 8.22.29 subject

Parameter subject : reference

Focus of message

Resource Communication
Expression Communication.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
 
http://hl7.org/fhir/SearchParameter/Communication-topic

Generated Narrative: SearchParameter Communication-topic

8.23.30 8.22.30 topic

Parameter topic : token

Description of the purpose/content

Resource Communication
Expression Communication.topic
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