Release 5 R6 Ballot (2nd Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot2: Release 6 Ballot (2nd Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions

2.15.14 2.15.13 Resource MessageHeader - Search Parameters

Infrastructure And Messaging icon Work Group Maturity Level : N/A   Trial Use Security Category : Not Classified Compartments : Device , Practitioner

Search parameters for the Resource MessageHeader - 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/MessageHeader-author http://hl7.org/fhir/SearchParameter/MessageHeader-code
2.15.15 author Parameter author : reference

Generated Narrative: SearchParameter MessageHeader-code The source of the decision

Resource MessageHeader Expression MessageHeader.author Processing Mode Normal Target Resources Device , Organization , PractitionerRole , Practitioner Multiples The parameter cannot repeat or have multiple values   http://hl7.org/fhir/SearchParameter/MessageHeader-code

2.15.16 2.15.14 code

Parameter code : token

ok | transient-error | fatal-error

Resource MessageHeader
Expression MessageHeader.response.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/MessageHeader-destination

2.15.17 Generated Narrative: SearchParameter MessageHeader-destination

2.15.15 destination

Parameter destination : string

Name of system

Resource MessageHeader
Expression MessageHeader.destination.name
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/MessageHeader-event

2.15.18 Generated Narrative: SearchParameter MessageHeader-event

2.15.16 event

Parameter event : token

Code for the event this message represents or link to event definition

Resource MessageHeader
Expression MessageHeader.event.ofType(Coding) | MessageHeader.event.ofType(canonical)
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/MessageHeader-focus

2.15.19 Generated Narrative: SearchParameter MessageHeader-focus

2.15.17 focus

Parameter focus : reference

The actual content of the message

Resource MessageHeader
Expression MessageHeader.focus
Processing Mode Normal
Target Resources All 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 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/MessageHeader-receiver

2.15.20 Generated Narrative: SearchParameter MessageHeader-receiver

2.15.18 receiver

Parameter receiver : reference

Intended "real-world" recipient for the data

Resource MessageHeader
Expression MessageHeader.destination.receiver
Processing Mode Normal
Target Resources Device , Organization , RelatedPerson , PractitionerRole , Practitioner , 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/MessageHeader-response-id

2.15.21 Generated Narrative: SearchParameter MessageHeader-response-id

2.15.19 response-id

Parameter response-id : token

Id of original message

Resource MessageHeader
Expression MessageHeader.response.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/MessageHeader-responsible http://hl7.org/fhir/SearchParameter/MessageHeader-sender
2.15.22 responsible Parameter responsible : reference

Generated Narrative: SearchParameter MessageHeader-sender Final responsibility for event

Resource MessageHeader Expression MessageHeader.responsible Processing Mode Normal Target Resources Organization , PractitionerRole , Practitioner Multiples The parameter cannot repeat or have multiple values   http://hl7.org/fhir/SearchParameter/MessageHeader-sender

2.15.23 2.15.20 sender

Parameter sender : reference

Real world sender of the message

Resource MessageHeader
Expression MessageHeader.sender MessageHeader.source.sender
Processing Mode Normal
Target Resources Device , Organization , PractitionerRole , Practitioner , 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/MessageHeader-source

2.15.24 Generated Narrative: SearchParameter MessageHeader-source

2.15.21 source

Parameter source : string

Name of system

Resource MessageHeader
Expression MessageHeader.source.name
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   http://hl7.org/fhir/SearchParameter/MessageHeader-target 2.15.25 target Parameter target : reference that must all be true
    • Particular delivery destination within
  • multipleOr: It's up to the server whether the destination Resource MessageHeader Expression MessageHeader.destination.target Processing Mode Normal Target Resources Device Multiples The parameter cannot repeat or can have multiple values (separated by comma) where at least one must be true