HL7.FHIR.US.PHCP\PhCP-Coverage

This page is part of the Pharmacist Care Plan FHIR IG (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: PhCP-Coverage

Defining URL:

http://hl7.org/fhir/us/phcp/StructureDefinition/PhCP-Coverage

Version:

1.0.0

Name:

PhCPCoverage

Status:

Draft as of 2017-07-21T16:02:00.2312151-04:00

Definition:

The Coverage profile groups the policy and authorization acts within a Payers Section to order the payment sources. The Coverage.identifier is the ID from the patient's insurance card.

Publisher:

HL7 Structured Documents Work Group

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/phcp/StructureDefinition/PhCP-Coverage

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from Coverage

Summary

Must-Support: 6 elements

Structures

This structure refers to these other structures:

This structure is derived from Coverage

Name	Flags	Card.	Type	Description & Constraints
Coverage		1..*	Coverage	Insurance or medical plan or a payment agreement
identifier	S	0..*	Identifier	Business Identifier for the coverage
type	S	0..1	CodeableConcept	Coverage category such as medical or accident
subscriber	S	0..1	Reference(US Core Patient Profile \| RelatedPerson)	Subscriber to the policy
subscriberId	S	0..1	string	ID assigned to the subscriber
beneficiary		1..1	Reference(US Core Patient Profile)	Plan beneficiary
relationship	S	0..1	CodeableConcept	Beneficiary relationship to the subscriber
payor	S	1..1	Reference(US Core Organization Profile \| US Core Patient Profile \| RelatedPerson)	Issuer of the policy
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Coverage		1..*	Coverage	Insurance or medical plan or a payment agreement
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business Identifier for the coverage
status	?!Σ	1..1	code	active \| cancelled \| draft \| entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
type	SΣ	0..1	CodeableConcept	Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.
policyHolder	Σ	0..1	Reference(Patient \| RelatedPerson \| Organization)	Owner of the policy
subscriber	SΣ	0..1	Reference(US Core Patient Profile \| RelatedPerson)	Subscriber to the policy
subscriberId	SΣ	0..1	string	ID assigned to the subscriber
beneficiary	Σ	1..1	Reference(US Core Patient Profile)	Plan beneficiary
dependent	Σ	0..1	string	Dependent number
relationship	S	0..1	CodeableConcept	Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
period	Σ	0..1	Period	Coverage start and end dates
payor	SΣ	1..1	Reference(US Core Organization Profile \| US Core Patient Profile \| RelatedPerson)	Issuer of the policy
class		0..*	BackboneElement	Additional coverage classifications
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
value	Σ	1..1	string	Value associated with the type
name	Σ	0..1	string	Human readable description of the type and value
order	Σ	0..1	positiveInt	Relative order of the coverage
network	Σ	0..1	string	Insurer network
costToBeneficiary		0..*	BackboneElement	Patient payments for services/products
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..1	CodeableConcept	Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.
value[x]	Σ	1..1		The amount or percentage due from the beneficiary
valueQuantity			Quantity(SimpleQuantity)
valueMoney			Money
exception		0..*	BackboneElement	Exceptions for patient payments
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.
period	Σ	0..1	Period	The effective period of the exception
subrogation		0..1	boolean	Reimbursement to insurer
contract		0..*	Reference(Contract)	Contract details
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Coverage		1..*	Coverage	Insurance or medical plan or a payment agreement
identifier	Σ	0..*	Identifier	Business Identifier for the coverage
type	Σ	0..1	CodeableConcept	Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.
subscriber	Σ	0..1	Reference(US Core Patient Profile \| RelatedPerson)	Subscriber to the policy
subscriberId	Σ	0..1	string	ID assigned to the subscriber
relationship		0..1	CodeableConcept	Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
payor	Σ	1..1	Reference(US Core Organization Profile \| US Core Patient Profile \| RelatedPerson)	Issuer of the policy
Documentation for this format

This structure is derived from Coverage

Summary

Must-Support: 6 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Coverage

Name	Flags	Card.	Type	Description & Constraints
Coverage		1..*	Coverage	Insurance or medical plan or a payment agreement
identifier	S	0..*	Identifier	Business Identifier for the coverage
type	S	0..1	CodeableConcept	Coverage category such as medical or accident
subscriber	S	0..1	Reference(US Core Patient Profile \| RelatedPerson)	Subscriber to the policy
subscriberId	S	0..1	string	ID assigned to the subscriber
beneficiary		1..1	Reference(US Core Patient Profile)	Plan beneficiary
relationship	S	0..1	CodeableConcept	Beneficiary relationship to the subscriber
payor	S	1..1	Reference(US Core Organization Profile \| US Core Patient Profile \| RelatedPerson)	Issuer of the policy
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Coverage		1..*	Coverage	Insurance or medical plan or a payment agreement
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business Identifier for the coverage
status	?!Σ	1..1	code	active \| cancelled \| draft \| entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
type	SΣ	0..1	CodeableConcept	Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.
policyHolder	Σ	0..1	Reference(Patient \| RelatedPerson \| Organization)	Owner of the policy
subscriber	SΣ	0..1	Reference(US Core Patient Profile \| RelatedPerson)	Subscriber to the policy
subscriberId	SΣ	0..1	string	ID assigned to the subscriber
beneficiary	Σ	1..1	Reference(US Core Patient Profile)	Plan beneficiary
dependent	Σ	0..1	string	Dependent number
relationship	S	0..1	CodeableConcept	Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
period	Σ	0..1	Period	Coverage start and end dates
payor	SΣ	1..1	Reference(US Core Organization Profile \| US Core Patient Profile \| RelatedPerson)	Issuer of the policy
class		0..*	BackboneElement	Additional coverage classifications
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
value	Σ	1..1	string	Value associated with the type
name	Σ	0..1	string	Human readable description of the type and value
order	Σ	0..1	positiveInt	Relative order of the coverage
network	Σ	0..1	string	Insurer network
costToBeneficiary		0..*	BackboneElement	Patient payments for services/products
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..1	CodeableConcept	Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.
value[x]	Σ	1..1		The amount or percentage due from the beneficiary
valueQuantity			Quantity(SimpleQuantity)
valueMoney			Money
exception		0..*	BackboneElement	Exceptions for patient payments
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.
period	Σ	0..1	Period	The effective period of the exception
subrogation		0..1	boolean	Reimbursement to insurer
contract		0..*	Reference(Contract)	Contract details
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet
Coverage.language	preferred	CommonLanguages Max Binding: AllLanguages
Coverage.status	required	FinancialResourceStatusCodes
Coverage.type	preferred	CoverageTypeAndSelf-PayCodes
Coverage.relationship	extensible	SubscriberRelationshipCodes
Coverage.class.type	extensible	CoverageClassCodes
Coverage.costToBeneficiary.type	extensible	CoverageCopayTypeCodes
Coverage.costToBeneficiary.exception.type	example	ExampleCoverageFinancialExceptionCodes

Constraints

Id	Path	Details	Requirements
dom-2	Coverage	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	Coverage	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	Coverage	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	Coverage	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Coverage	A resource should have narrative for robust management : text.`div`.exists()
ele-1	Coverage.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Coverage.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Coverage.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Coverage.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Coverage.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.policyHolder	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.subscriber	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.subscriberId	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.beneficiary	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.dependent	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.relationship	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.payor	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.class	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.class.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Coverage.class.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Coverage.class.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Coverage.class.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Coverage.class.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.class.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.class.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.order	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.network	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.costToBeneficiary	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.costToBeneficiary.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Coverage.costToBeneficiary.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Coverage.costToBeneficiary.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Coverage.costToBeneficiary.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Coverage.costToBeneficiary.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.costToBeneficiary.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.costToBeneficiary.exception	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.costToBeneficiary.exception.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Coverage.costToBeneficiary.exception.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Coverage.costToBeneficiary.exception.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Coverage.costToBeneficiary.exception.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Coverage.costToBeneficiary.exception.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.costToBeneficiary.exception.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.subrogation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Coverage.contract	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())