Release 5 R6 Ballot (1st Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot1: Release 6 Ballot (1st 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

8.34.13 Resource InsurancePlan - Search Parameters

Patient Administration icon Work Group Maturity Level : N/A   Trial Use Security Category : Business Compartments : No defined compartments

Search parameters for the Resource InsurancePlan - 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/InsurancePlan-address http://hl7.org/fhir/SearchParameter/InsurancePlan-coverage-area

8.34.14 address coverage-area

Parameter address coverage-area : string reference

A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text Location(s) insurance product is intended for/available to

Resource InsurancePlan
Expression InsurancePlan.contact.address InsurancePlan.coverageArea
Processing Mode Normal
Multiples The parameter cannot repeat or have multiple values   http://hl7.org/fhir/SearchParameter/InsurancePlan-address-city 8.34.15 address-city Parameter address-city : string A city specified in an address Resource Target Resources InsurancePlan Location
Expression InsurancePlan.contact.address.city Processing Mode Multiples 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/InsurancePlan-address-country 8.34.16 address-country Parameter address-country : string A country specified in an address Resource InsurancePlan Expression InsurancePlan.contact.address.country Processing Mode Normal Multiples that must all be true
    • The
  • multipleOr: It's up to the server whether the parameter cannot repeat or can have multiple values   http://hl7.org/fhir/SearchParameter/InsurancePlan-address-postalcode 8.34.17 address-postalcode Parameter address-postalcode : string A postal code specified in an address Resource InsurancePlan Expression InsurancePlan.contact.address.postalCode Processing Mode Normal (separated by comma) where at least one must be true
    • Multiples
The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/InsurancePlan-address-state http://hl7.org/fhir/SearchParameter/InsurancePlan-identifier

8.34.18 8.34.15 address-state identifier

Parameter address-state identifier : string token

A state specified in an address External identifiers for this item

Resource InsurancePlan
Expression InsurancePlan.contact.address.state InsurancePlan.identifier
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/InsurancePlan-address-use 8.34.19 address-use Parameter address-use : token A use code specified in an address Resource InsurancePlan Expression InsurancePlan.contact.address.use Processing Mode Normal Multiples that must all be true
    • The
  • multipleOr: It's up to the server whether the parameter cannot repeat or can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/InsurancePlan-administered-by http://hl7.org/fhir/SearchParameter/InsurancePlan-network

8.34.20 8.34.16 administered-by network

Parameter administered-by network : reference

Product administrator The product this plan is available to

Resource InsurancePlan
Expression InsurancePlan.administeredBy InsurancePlan.network
Processing Mode Normal
Target Resources Organization
Multiples The parameter cannot repeat or have multiple values   http://hl7.org/fhir/SearchParameter/InsurancePlan-endpoint 8.34.21 endpoint Parameter endpoint : reference Technical endpoint Resource InsurancePlan Expression InsurancePlan.endpoint Processing Mode Normal Target Resources Endpoint 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/InsurancePlan-identifier 8.34.22 identifier Parameter identifier : token that must all be true
    • Any identifier for
  • multipleOr: It's up to the organization (not server whether the accreditation issuer's identifier) Resource InsurancePlan Expression InsurancePlan.identifier Processing Mode Normal Multiples The parameter cannot repeat or can have multiple values   http://hl7.org/fhir/SearchParameter/InsurancePlan-name 8.34.23 name Parameter name : string A portion of the organization's name or alias Resource InsurancePlan Expression InsurancePlan.name | InsurancePlan.alias Processing Mode Normal (separated by comma) where at least one must be true
    • Multiples
The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/InsurancePlan-owned-by http://hl7.org/fhir/SearchParameter/InsurancePlan-product

8.34.24 8.34.17 owned-by product

Parameter owned-by product : reference

An organization of which The product this organization forms a part plan is available to

Resource InsurancePlan
Expression InsurancePlan.ownedBy InsurancePlan.product
Processing Mode Normal
Target Resources Organization Multiples The parameter cannot repeat or have multiple values   http://hl7.org/fhir/SearchParameter/InsurancePlan-phonetic 8.34.25 phonetic Parameter phonetic : string
    A portion of
  • multipleAnd: It's up to the server whether the organization's name using some kind of phonetic matching algorithm Resource InsurancePlan Expression InsurancePlan.name Processing Mode Phonetic Multiples The parameter cannot may repeat or have in order to specify multiple values   http://hl7.org/fhir/SearchParameter/InsurancePlan-status 8.34.26 status Parameter status : token that must all be true
    • Is
  • multipleOr: It's up to the server whether the Organization record active Resource InsurancePlan Expression InsurancePlan.status Processing Mode Normal 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/InsurancePlan-type

8.34.27 8.34.18 type

Parameter type : token

A code for the type of organization insurance plan

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