Skip to main content

Coverage

Trial Use 2 Financial

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Coverage
InteractionMethodPath
ReadGET/fhir/R4/Coverage/[id]
VreadGET/fhir/R4/Coverage/[id]/_history/[vid]
UpdatePUT/fhir/R4/Coverage/[id]
PatchPATCH/fhir/R4/Coverage/[id]
DeleteDELETE/fhir/R4/Coverage/[id]
CreatePOST/fhir/R4/Coverage
SearchGET/fhir/R4/Coverage
HistoryGET/fhir/R4/Coverage/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*Business Identifier for the coverage
statuscode1..1active | cancelled | draft | entered-in-error modifier
typeCodeableConcept0..1Coverage category such as medical or accident
policyHolderReference0..1Owner of the policy
subscriberReference0..1Subscriber to the policy
subscriberIdstring0..1ID assigned to the subscriber
beneficiaryReference1..1Plan beneficiary
dependentstring0..1Dependent number
relationshipCodeableConcept0..1Beneficiary relationship to the subscriber
periodPeriod0..1Coverage start and end dates
payorReference1..*Issuer of the policy
classBackboneElement0..*Additional coverage classifications
orderpositiveInt0..1Relative order of the coverage
networkstring0..1Insurer network
costToBeneficiaryBackboneElement0..*Patient payments for services/products
subrogationboolean0..1Reimbursement to insurer
contractReference0..*Contract details

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
beneficiarystringhttp://hl7.org/fhir/SearchParameter/Coverage-beneficiary
class-typestringhttp://hl7.org/fhir/SearchParameter/Coverage-class-type
class-valuestringhttp://hl7.org/fhir/SearchParameter/Coverage-class-value
dependentstringhttp://hl7.org/fhir/SearchParameter/Coverage-dependent
identifierstringhttp://hl7.org/fhir/SearchParameter/Coverage-identifier
patientstringhttp://hl7.org/fhir/SearchParameter/Coverage-patient
payorstringhttp://hl7.org/fhir/SearchParameter/Coverage-payor
policy-holderstringhttp://hl7.org/fhir/SearchParameter/Coverage-policy-holder
statusstringhttp://hl7.org/fhir/SearchParameter/Coverage-status
subscriberstringhttp://hl7.org/fhir/SearchParameter/Coverage-subscriber
typestringhttp://hl7.org/fhir/SearchParameter/Coverage-type

Reference​

  • Official FHIR R4 spec: Coverage
  • Maturity: Trial Use 2 (FMM 2).