Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon

13.1.13 13.1.12 Resource Coverage - Search Parameters

Maturity Level : N/A
Responsible Owner: Financial Management icon Work Group   Trial Use Normative Security Category : Patient Compartments : Patient , RelatedPerson

Search parameters for the Resource Coverage - 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/Coverage-beneficiary

13.1.14 Generated Narrative: SearchParameter Coverage-beneficiary

13.1.13 beneficiary

Parameter beneficiary : reference

Covered party

Resource Coverage
Expression Coverage.beneficiary
Processing Mode Normal
Target Resources 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/Coverage-class-type

13.1.15 Generated Narrative: SearchParameter Coverage-class-type

13.1.14 class-type

Parameter class-type : token

Coverage class (e.g. plan, group)

Resource Coverage
Expression Coverage.class.type
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/Coverage-class-value

13.1.16 Generated Narrative: SearchParameter Coverage-class-value

13.1.15 class-value

Parameter class-value : token

Value of the class (e.g. Plan number, group number)

Resource Coverage
Expression Coverage.class.value
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/Coverage-dependent

13.1.17 Generated Narrative: SearchParameter Coverage-dependent

13.1.16 dependent

Parameter dependent : string

Dependent number

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

13.1.18 Generated Narrative: SearchParameter clinical-identifier

13.1.17 identifier

Parameter identifier : token

Coverage : The primary identifier of the insured and the coverage

Resource Coverage
Expression Coverage.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/Coverage-insurer

13.1.19 Generated Narrative: SearchParameter Coverage-insurer

13.1.18 insurer

Parameter insurer : reference

The identity of the insurer

Resource Coverage
Expression Coverage.insurer
Processing Mode Normal
Target Resources Organization
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/clinical-patient
This search parameter is part of the common search parameter clinical-patient

13.1.20 Generated Narrative: SearchParameter clinical-patient

13.1.19 patient

Parameter patient : reference

Coverage : Retrieve coverages for a patient

Resource Coverage
Expression Coverage.beneficiary
Processing Mode Normal
Target Resources 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/Coverage-paymentby-party

13.1.21 Generated Narrative: SearchParameter Coverage-paymentby-party

13.1.20 paymentby-party

Parameter paymentby-party : reference

Parties who will pay for services

Resource Coverage
Expression Coverage.paymentBy.party
Processing Mode Normal
Target Resources Organization , RelatedPerson , 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/Coverage-period

Generated Narrative: SearchParameter Coverage-period

13.1.21 period

Parameter period : date

Dates that the Coverage is active

Resource Coverage
Expression Coverage.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/Coverage-policy-holder

Generated Narrative: SearchParameter Coverage-policy-holder

13.1.22 policy-holder

Parameter policy-holder : reference

Reference to the policyholder

Resource Coverage
Expression Coverage.policyHolder
Processing Mode Normal
Target Resources Organization , RelatedPerson , 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/Coverage-status

Generated Narrative: SearchParameter Coverage-status

13.1.23 status

Parameter status : token

The status of the Coverage

Resource Coverage
Expression Coverage.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/Coverage-subscriber

Generated Narrative: SearchParameter Coverage-subscriber

13.1.24 subscriber

Parameter subscriber : reference

Reference to the subscriber

Resource Coverage
Expression Coverage.subscriber
Processing Mode Normal
Target Resources RelatedPerson , 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/Coverage-subscriberid

Generated Narrative: SearchParameter Coverage-subscriberid

13.1.25 subscriberid

Parameter subscriberid : token

Identifier of the subscriber

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

Generated Narrative: SearchParameter clinical-type

13.1.26 type

Parameter type : token

Coverage : The kind of coverage (health plan, auto, Workers Compensation)

Resource Coverage
Expression Coverage.type
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