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

8.34.13 8.31.13 Resource InsurancePlan - Search Parameters

Maturity Level : N/A
Responsible Owner: Patient Administration icon Work Group   Trial Use Normative 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

Parameter address : string Generated Narrative: SearchParameter InsurancePlan-coverage-area

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 Resource InsurancePlan Expression InsurancePlan.contact.address Processing Mode Normal Multiples The parameter cannot repeat or have multiple values   http://hl7.org/fhir/SearchParameter/InsurancePlan-address-city

8.34.15 8.31.14 address-city coverage-area

Parameter address-city coverage-area : string reference

A city specified in an address Location(s) insurance product is intended for/available to

Multiples The parameter cannot repeat or have 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 Expression InsurancePlan.contact.address.country
Resource InsurancePlan
Expression InsurancePlan.contact.address.city InsurancePlan.coverageArea
Processing Mode Normal
Resource Target Resources InsurancePlan Location
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-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 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-address-state http://hl7.org/fhir/SearchParameter/InsurancePlan-identifier
8.34.18 address-state Parameter address-state : string

Generated Narrative: SearchParameter InsurancePlan-identifier A state specified in an address

Resource InsurancePlan Expression InsurancePlan.contact.address.state Processing Mode Normal Multiples The parameter cannot repeat or have multiple values   http://hl7.org/fhir/SearchParameter/InsurancePlan-address-use

8.34.19 8.31.15 address-use identifier

Parameter address-use identifier : token

A use code specified in an address External identifiers for this item

Resource InsurancePlan
Expression InsurancePlan.contact.address.use InsurancePlan.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/InsurancePlan-administered-by http://hl7.org/fhir/SearchParameter/InsurancePlan-network
8.34.20 administered-by Parameter administered-by : reference

Generated Narrative: SearchParameter InsurancePlan-network Product administrator

Resource InsurancePlan Expression InsurancePlan.administeredBy 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 8.31.16 endpoint network

Parameter endpoint network : reference

Technical endpoint The product this plan is available to

Resource InsurancePlan
Expression InsurancePlan.endpoint InsurancePlan.network
Processing Mode Normal
Target Resources Endpoint Organization
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 (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/InsurancePlan-name http://hl7.org/fhir/SearchParameter/InsurancePlan-product
8.34.23 name Parameter name : string

Generated Narrative: SearchParameter InsurancePlan-product A portion of the organization's name or alias

Resource InsurancePlan Expression InsurancePlan.name | InsurancePlan.alias Processing Mode Normal Multiples The parameter cannot repeat or have multiple values   http://hl7.org/fhir/SearchParameter/InsurancePlan-owned-by

8.34.24 8.31.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 InsuranceProduct
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-phonetic 8.34.25 phonetic Parameter phonetic : string that must all be true
    • A portion of
  • multipleOr: 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 repeat or can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/InsurancePlan-status http://hl7.org/fhir/SearchParameter/InsurancePlan-type
8.34.26 status

Parameter status : token Generated Narrative: SearchParameter InsurancePlan-type

Is the Organization record active Resource InsurancePlan Expression InsurancePlan.status Processing Mode Normal Multiples The parameter cannot repeat or have multiple values   http://hl7.org/fhir/SearchParameter/InsurancePlan-type

8.34.27 8.31.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