FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this 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

Expansionprofile-example

2.12.20 Resource Subscription - Search Parameters

Responsible Owner: FHIR Infrastructure icon Vocabulary Work Group   Normative Maturity Level : N/A Ballot Status Security Category : Informative Business Compartments : Not linked to any No defined compartments

This is the narrative Search parameters for the Subscription resource. See 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/Subscription-contact

Generated Narrative: SearchParameter Subscription-contact

2.12.21 contact

Parameter contact : token

Contact details for the XML subscription

Resource Subscription or JSON
Expression Subscription.contact
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/Subscription-content-level format. This example conforms

Generated Narrative: SearchParameter Subscription-content-level

2.12.22 content-level

Parameter content-level : token

Content level included in notifications

Resource Subscription
Expression Subscription.content
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the profile ExpansionProfile . 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/Subscription-filter-event

Generated Narrative: SearchParameter Subscription-filter-event

2.12.23 filter-event

Parameter filter-event : token

[ Provide Rendering ]

Filter event used to narrow notifications

Resource Subscription
Expression Subscription.filterBy.event
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/Subscription-filter-value

Generated Narrative: SearchParameter Subscription-filter-value

2.12.24 filter-value

Parameter filter-value : string

Filter value used to narrow notifications

Resource Subscription
Expression Subscription.filterBy.value
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/Subscription-identifier

Generated Narrative: SearchParameter Subscription-identifier

2.12.25 identifier

Parameter identifier : token

A subscription identifier

Resource Subscription
Expression Subscription.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/Subscription-name

Generated Narrative: SearchParameter Subscription-name

2.12.26 name

Usage note: every effort has been made Parameter name : string

A human-readable name

Resource Subscription
Expression Subscription.name
Processing Mode Normal
Multiples
  • multipleAnd: It's up to ensure the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the examples are correct and useful, but they are not a normative part server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Subscription-owner

Generated Narrative: SearchParameter Subscription-owner

2.12.27 owner

Parameter owner : reference

The managing entity

Resource Subscription
Expression Subscription.managingEntity
Processing Mode Normal
Target Resources HealthcareService , CareTeam , Device , Organization , RelatedPerson , PractitionerRole , Group , 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/Subscription-payload

Generated Narrative: SearchParameter Subscription-payload

2.12.28 payload

Parameter payload : token

The mime-type of notifications

Resource Subscription
Expression Subscription.contentType
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the specification. 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/Subscription-status

Generated Narrative: SearchParameter Subscription-status

2.12.29 status

Parameter status : token

The current state of the subscription

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

Generated Narrative: SearchParameter Subscription-topic

2.12.30 topic

Parameter topic : uri

The canonical topic url that triggers notifications

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

Generated Narrative: SearchParameter Subscription-type

2.12.31 type

Parameter type : token

The type of channel for the sent notifications

Resource Subscription
Expression Subscription.channelType
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/Subscription-url

Generated Narrative: SearchParameter Subscription-url

2.12.32 url

Parameter url : uri

The uri that will receive the notifications

Resource Subscription
Expression Subscription.endpoint
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