Coverage

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

Interaction	Method	Path
Read	GET	/fhir/R4/Coverage/[id]
Vread	GET	/fhir/R4/Coverage/[id]/_history/[vid]
Update	PUT	/fhir/R4/Coverage/[id]
Patch	PATCH	/fhir/R4/Coverage/[id]
Delete	DELETE	/fhir/R4/Coverage/[id]
Create	POST	/fhir/R4/Coverage
Search	GET	/fhir/R4/Coverage
History	GET	/fhir/R4/Coverage/[id]/_history

Top-level elements

Element	Type	Cardinality	Description
id	string	0..1	Logical id of this artifact
meta	Meta	0..1	Metadata about the resource
implicitRules	uri	0..1	A set of rules under which this content was created
language	code	0..1	Language of the resource content
text	Narrative	0..1	Text summary of the resource, for human interpretation
contained	Resource	0..*	Contained, inline Resources
extension	Extension	0..*	Additional content defined by implementations
modifierExtension	Extension	0..*	Extensions that cannot be ignored
identifier	Identifier	0..*	Business Identifier for the coverage
status	code	1..1	active | cancelled | draft | entered-in-error
type	CodeableConcept	0..1	Coverage category such as medical or accident
policyHolder	Reference	0..1	Owner of the policy
subscriber	Reference	0..1	Subscriber to the policy
subscriberId	string	0..1	ID assigned to the subscriber
beneficiary	Reference	1..1	Plan beneficiary
dependent	string	0..1	Dependent number
relationship	CodeableConcept	0..1	Beneficiary relationship to the subscriber
period	Period	0..1	Coverage start and end dates
payor	Reference	1..*	Issuer of the policy
class	BackboneElement	0..*	Additional coverage classifications
order	positiveInt	0..1	Relative order of the coverage
network	string	0..1	Insurer network
costToBeneficiary	BackboneElement	0..*	Patient payments for services/products
subrogation	boolean	0..1	Reimbursement to insurer
contract	Reference	0..*	Contract details

Resource-specific search parameters

Parameter	Type	Description
beneficiary	reference	Covered party
class-type	token	Coverage class (eg. plan, group)
class-value	string	Value of the class (eg. Plan number, group number)
dependent	string	Dependent number
identifier	token	The primary identifier of the insured and the coverage
patient	reference	Retrieve coverages for a patient
payor	reference	The identity of the insurer or party paying for services
policy-holder	reference	Reference to the policyholder
status	token	The status of the Coverage
subscriber	reference	Reference to the subscriber
type	token	The kind of coverage (health plan, auto, Workers Compensation)

Reference

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