FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

13.1.13 Resource Coverage - Search Parameters

Financial Management icon Work GroupMaturity Level: N/A  Trial UseSecurity 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 beneficiary

Parameter beneficiary:reference

Covered party

ResourceCoverage
ExpressionCoverage.beneficiary
Processing ModeNormal
Target ResourcesPatient
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/Coverage-class-type

13.1.15 class-type

Parameter class-type:token

Coverage class (e.g. plan, group)

ResourceCoverage
ExpressionCoverage.class.type
Processing ModeNormal
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/Coverage-class-value

13.1.16 class-value

Parameter class-value:token

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

ResourceCoverage
ExpressionCoverage.class.value
Processing ModeNormal
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/Coverage-dependent

13.1.17 dependent

Parameter dependent:string

Dependent number

ResourceCoverage
ExpressionCoverage.dependent
Processing ModeNormal
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

13.1.18 identifier

Parameter identifier:token

Coverage: The primary identifier of the insured and the coverage

ResourceCoverage
ExpressionCoverage.identifier
Processing ModeNormal
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/Coverage-insurer

13.1.19 insurer

Parameter insurer:reference

The identity of the insurer

ResourceCoverage
ExpressionCoverage.insurer
Processing ModeNormal
Target ResourcesOrganization
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

13.1.20 patient

Parameter patient:reference

Coverage: Retrieve coverages for a patient

ResourceCoverage
ExpressionCoverage.beneficiary
Processing ModeNormal
Target ResourcesPatient
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/Coverage-paymentby-party

13.1.21 paymentby-party

Parameter paymentby-party:reference

Parties who will pay for services

ResourceCoverage
ExpressionCoverage.paymentBy.party
Processing ModeNormal
Target ResourcesOrganization, RelatedPerson, 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/Coverage-policy-holder

13.1.22 policy-holder

Parameter policy-holder:reference

Reference to the policyholder

ResourceCoverage
ExpressionCoverage.policyHolder
Processing ModeNormal
Target ResourcesOrganization, RelatedPerson, 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/Coverage-status

13.1.23 status

Parameter status:token

The status of the Coverage

ResourceCoverage
ExpressionCoverage.status
Processing ModeNormal
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/Coverage-subscriber

13.1.24 subscriber

Parameter subscriber:reference

Reference to the subscriber

ResourceCoverage
ExpressionCoverage.subscriber
Processing ModeNormal
Target ResourcesRelatedPerson, 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/Coverage-subscriberid

13.1.25 subscriberid

Parameter subscriberid:token

Identifier of the subscriber

ResourceCoverage
ExpressionCoverage.subscriberId
Processing ModeNormal
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-type
This search parameter is part of the common search parameter clinical-type

13.1.26 type

Parameter type:token

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

ResourceCoverage
ExpressionCoverage.type
Processing ModeNormal
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