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.16.12 2.16.11 Resource MessageDefinition - Search Parameters

Infrastructure And Messaging icon Work Group Maturity Level : N/A   Trial Use Security Category : Anonymous Compartments : No defined compartments

Search parameters for the Resource MessageDefinition - 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/MessageDefinition-category

2.16.13 Generated Narrative: SearchParameter MessageDefinition-category

2.16.12 category

Parameter category : token

The behavior associated with the message

Resource MessageDefinition
Expression MessageDefinition.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/CanonicalResource-context
This search parameter is part of the common search parameter CanonicalResource-context

2.16.14 Generated Narrative: SearchParameter CanonicalResource-context

2.16.13 context

Parameter context : token

MessageDefinition : A use context assigned to the message definition

Resource MessageDefinition
Expression (MessageDefinition.useContext.value.ofType(CodeableConcept))
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/CanonicalResource-context-quantity
This search parameter is part of the common search parameter CanonicalResource-context-quantity

2.16.15 Generated Narrative: SearchParameter CanonicalResource-context-quantity

2.16.14 context-quantity

Parameter context-quantity : quantity

MessageDefinition : A quantity- or range-valued use context assigned to the message definition

Resource MessageDefinition
Expression (MessageDefinition.useContext.value.ofType(Quantity)) | (MessageDefinition.useContext.value.ofType(Range))
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/CanonicalResource-context-type
This search parameter is part of the common search parameter CanonicalResource-context-type

2.16.16 Generated Narrative: SearchParameter CanonicalResource-context-type

2.16.15 context-type

Parameter context-type : token

MessageDefinition : A type of use context assigned to the message definition

Resource MessageDefinition
Expression MessageDefinition.useContext.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/CanonicalResource-context-type-quantity
This search parameter is part of the common search parameter CanonicalResource-context-type-quantity

2.16.17 Generated Narrative: SearchParameter CanonicalResource-context-type-quantity

2.16.16 context-type-quantity

Parameter context-type-quantity : composite

MessageDefinition : A use context type and quantity- or range-based value assigned to the message definition

Resource MessageDefinition
Expression MessageDefinition.useContext
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

context-type code
context-quantity value.ofType(Quantity) | value.ofType(Range)
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-context-type-value
This search parameter is part of the common search parameter CanonicalResource-context-type-value

2.16.18 Generated Narrative: SearchParameter CanonicalResource-context-type-value

2.16.17 context-type-value

Parameter context-type-value : composite

MessageDefinition : A use context type and value assigned to the message definition

Resource MessageDefinition
Expression MessageDefinition.useContext
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

context-type code
context value.ofType(CodeableConcept)
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-date
This search parameter is part of the common search parameter CanonicalResource-date

2.16.19 Generated Narrative: SearchParameter CanonicalResource-date

2.16.18 date

Parameter date : date

MessageDefinition : The message definition publication date

Resource MessageDefinition
Expression MessageDefinition.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/CanonicalResource-description
This search parameter is part of the common search parameter CanonicalResource-description

2.16.20 Generated Narrative: SearchParameter CanonicalResource-description

2.16.19 description

Parameter description : string

MessageDefinition : The description of the message definition

Resource MessageDefinition
Expression MessageDefinition.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/MessageDefinition-event

2.16.21 Generated Narrative: SearchParameter MessageDefinition-event

2.16.20 event

Parameter event : token

The event that triggers the message or link to the event definition.

Resource MessageDefinition
Expression MessageDefinition.event.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/MessageDefinition-focus

2.16.22 Generated Narrative: SearchParameter MessageDefinition-focus

2.16.21 focus

Parameter focus : token

A resource that is a permitted focus of the message

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

2.16.23 Generated Narrative: SearchParameter CanonicalResource-identifier

2.16.22 identifier

Parameter identifier : token

MessageDefinition : External identifier for the message definition

Resource MessageDefinition
Expression MessageDefinition.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/CanonicalResource-jurisdiction
This search parameter is part of the common search parameter CanonicalResource-jurisdiction

2.16.24 Generated Narrative: SearchParameter CanonicalResource-jurisdiction

2.16.23 jurisdiction

Parameter jurisdiction : token

MessageDefinition : Intended jurisdiction for the message definition

Resource MessageDefinition
Expression MessageDefinition.jurisdiction
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/CanonicalResource-name
This search parameter is part of the common search parameter CanonicalResource-name

2.16.25 Generated Narrative: SearchParameter CanonicalResource-name

2.16.24 name

Parameter name : string

MessageDefinition : Computationally friendly name of the message definition

Resource MessageDefinition
Expression MessageDefinition.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/MessageDefinition-parent 2.16.26 parent Parameter parent : reference A resource that is must all be true
  • multipleOr: It's up to the parent of server whether the definition Resource MessageDefinition Expression MessageDefinition.parent Processing Mode Normal Target Resources ActivityDefinition , PlanDefinition Multiples The parameter cannot repeat or can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-publisher
This search parameter is part of the common search parameter CanonicalResource-publisher

2.16.27 Generated Narrative: SearchParameter CanonicalResource-publisher

2.16.25 publisher

Parameter publisher : string

MessageDefinition : Name of the publisher of the message definition

Resource MessageDefinition
Expression MessageDefinition.publisher
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/CanonicalResource-status
This search parameter is part of the common search parameter CanonicalResource-status

2.16.28 Generated Narrative: SearchParameter CanonicalResource-status

2.16.26 status

Parameter status : token

MessageDefinition : The current status of the message definition

Resource MessageDefinition
Expression MessageDefinition.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/CanonicalResource-title
This search parameter is part of the common search parameter CanonicalResource-title

2.16.29 Generated Narrative: SearchParameter CanonicalResource-title

2.16.27 title

Parameter title : string

MessageDefinition : The human-friendly name of the message definition

Resource MessageDefinition
Expression MessageDefinition.title
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/CanonicalResource-url
This search parameter is part of the common search parameter CanonicalResource-url

2.16.30 Generated Narrative: SearchParameter CanonicalResource-url

2.16.28 url

Parameter url : uri

MessageDefinition : The uri that identifies the message definition

Resource MessageDefinition
Expression MessageDefinition.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/CanonicalResource-version
This search parameter is part of the common search parameter CanonicalResource-version

2.16.31 Generated Narrative: SearchParameter CanonicalResource-version

2.16.29 version

Parameter version : token

MessageDefinition : The business version of the message definition

Resource MessageDefinition
Expression MessageDefinition.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