This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.1.0-preview: STU 2.1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.1. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: CRD Coverage

This profile specifies constraints on the Coverage resource to support coverage requirements discovery.

Usage:

• Refer to this Resource Profile: Coverage Information

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from USCoreCoverageProfile

Name	Flags	Card.	Type	Description & Constraints
Coverage		0..*	USCoreCoverageProfile(7.0.0)	Insurance or medical plan or a payment agreement This profile also complies with the profile US Core Practitioner Profile (6.1.0)
policyHolder	S	0..1	Reference(CRD Patient | CRD Organization)	Owner of the policy
subscriber	S	0..1	Reference(CRD Patient)	Subscriber to the policy
beneficiary		1..1	Reference(CRD Patient)	Plan beneficiary
dependent	S	0..1	string	Dependent number
payor		1..1	Reference(CRD Patient | CRD Organization)	Issuer of the policy
order	S	0..1	positiveInt	Relative order of the coverage
network	S	0..1	string	Insurer network
costToBeneficiary		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Coverage	C	0..*	USCoreCoverageProfile(7.0.0)	Insurance or medical plan or a payment agreement This profile also complies with the profile US Core Practitioner Profile (6.1.0) us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	Member ID and other identifiers Slice: Unordered, Open by pattern:type
identifier:memberid	SΣC	0..1	Identifier	Member ID
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Member Number identifier type Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MB
status	?!SΣ	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: Payer Type (extensible): US Public Health Data Consortium Source of Payment Codes
policyHolder	SΣ	0..1	Reference(CRD Patient | CRD Organization)	Owner of the policy
subscriber	SΣ	0..1	Reference(CRD Patient)	Subscriber to the policy
subscriberId	SΣC	0..1	string	ID assigned to the subscriber
beneficiary	SΣ	1..1	Reference(CRD Patient)	Plan beneficiary
dependent	SΣ	0..1	string	Dependent number
relationship	S	1..1	CodeableConcept	Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible)
period	SΣ	0..1	Period	Coverage start and end dates
payor	SΣ	1..1	Reference(CRD Patient | CRD Organization)	Issuer of the policy
Slices for class	S	0..*	BackboneElement	Additional coverage classifications Slice: Unordered, Open by pattern:type
class:All Slices				Content/Rules for all slices
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
class:group	S	0..1	BackboneElement	Group
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. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
code		1..1	code	Symbol in syntax defined by the system Fixed Value: group
value	SΣ	1..1	string	Group Number
name	SΣ	0..1	string	Group Name
class:plan	S	0..1	BackboneElement	Plan
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. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
code		1..1	code	Symbol in syntax defined by the system Fixed Value: plan
value	SΣ	1..1	string	Plan Number
name	SΣ	0..1	string	Plan Name
order	SΣ	0..1	positiveInt	Relative order of the coverage
network	SΣ	0..1	string	Insurer network
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Coverage.identifier:memberid.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Coverage.identifier:memberid.type	extensible	Pattern: MB http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Coverage.status	required	FinancialResourceStatusCodes http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
Coverage.type	extensible	PayerType (a valid code from Source of Payment Typology (https://nahdo.org/sopt) http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591 from https://vsac.nlm.nih.gov
Coverage.relationship	extensible	SubscriberRelationshipCodes http://hl7.org/fhir/ValueSet/subscriber-relationship from the FHIR Standard
Coverage.class.type	extensible	CoverageClassCodes http://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard
Coverage.class:group.type	extensible	Pattern: group http://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard
Coverage.class:plan.type	extensible	Pattern: plan http://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Coverage	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	Coverage	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Coverage	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
us-core-15	error	Coverage	Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present : identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists()

Name	Flags	Card.	Type	Description & Constraints
Coverage	C	0..*	USCoreCoverageProfile(7.0.0)	Insurance or medical plan or a payment agreement This profile also complies with the profile US Core Practitioner Profile (6.1.0) us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present
id	Σ	0..1	id	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): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
Slices for identifier	SΣ	0..*	Identifier	Member ID and other identifiers Slice: Unordered, Open by pattern:type
identifier:memberid	SΣC	0..1	Identifier	Member ID
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Member Number identifier type Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MB
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!SΣ	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: Payer Type (extensible): US Public Health Data Consortium Source of Payment Codes
policyHolder	SΣ	0..1	Reference(CRD Patient | CRD Organization)	Owner of the policy
subscriber	SΣ	0..1	Reference(CRD Patient)	Subscriber to the policy
subscriberId	SΣC	0..1	string	ID assigned to the subscriber
beneficiary	SΣ	1..1	Reference(CRD Patient)	Plan beneficiary
dependent	SΣ	0..1	string	Dependent number
relationship	S	1..1	CodeableConcept	Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible)
period	SΣ	0..1	Period	Coverage start and end dates
payor	SΣ	1..1	Reference(CRD Patient | CRD Organization)	Issuer of the policy
Slices for class	S	0..*	BackboneElement	Additional coverage classifications Slice: Unordered, Open by pattern:type
class:All Slices				Content/Rules for all slices
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
class:group	S	0..1	BackboneElement	Group
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: group
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
value	SΣ	1..1	string	Group Number
name	SΣ	0..1	string	Group Name
class:plan	S	0..1	BackboneElement	Plan
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: plan
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
value	SΣ	1..1	string	Plan Number
name	SΣ	0..1	string	Plan Name
order	SΣ	0..1	positiveInt	Relative order of the coverage
network	SΣ	0..1	string	Insurer network
subrogation		0..1	boolean	Reimbursement to insurer
contract		0..*	Reference(Contract)	Contract details
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Coverage.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Coverage.identifier:memberid.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Coverage.identifier:memberid.type	extensible	Pattern: MB http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Coverage.status	required	FinancialResourceStatusCodes http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
Coverage.type	extensible	PayerType (a valid code from Source of Payment Typology (https://nahdo.org/sopt) http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591 from https://vsac.nlm.nih.gov
Coverage.relationship	extensible	SubscriberRelationshipCodes http://hl7.org/fhir/ValueSet/subscriber-relationship from the FHIR Standard
Coverage.class.type	extensible	CoverageClassCodes http://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard
Coverage.class:group.type	extensible	Pattern: group http://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard
Coverage.class:plan.type	extensible	Pattern: plan http://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard
Coverage.costToBeneficiary.type	extensible	CoverageCopayTypeCodes http://hl7.org/fhir/ValueSet/coverage-copay-type from the FHIR Standard
Coverage.costToBeneficiary.exception.type	example	ExampleCoverageFinancialExceptionCodes http://hl7.org/fhir/ValueSet/coverage-financial-exception from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Coverage	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	Coverage	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Coverage	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
us-core-15	error	Coverage	Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present : identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists()

This structure is derived from USCoreCoverageProfile

Summary

Must-Support: 5 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• CRD Patient (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-patient)
• CRD Organization (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-organization)

Maturity: 2

Differential View

This structure is derived from USCoreCoverageProfile

Name	Flags	Card.	Type	Description & Constraints
Coverage		0..*	USCoreCoverageProfile(7.0.0)	Insurance or medical plan or a payment agreement This profile also complies with the profile US Core Practitioner Profile (6.1.0)
policyHolder	S	0..1	Reference(CRD Patient | CRD Organization)	Owner of the policy
subscriber	S	0..1	Reference(CRD Patient)	Subscriber to the policy
beneficiary		1..1	Reference(CRD Patient)	Plan beneficiary
dependent	S	0..1	string	Dependent number
payor		1..1	Reference(CRD Patient | CRD Organization)	Issuer of the policy
order	S	0..1	positiveInt	Relative order of the coverage
network	S	0..1	string	Insurer network
costToBeneficiary		0..0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Coverage	C	0..*	USCoreCoverageProfile(7.0.0)	Insurance or medical plan or a payment agreement This profile also complies with the profile US Core Practitioner Profile (6.1.0) us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	Member ID and other identifiers Slice: Unordered, Open by pattern:type
identifier:memberid	SΣC	0..1	Identifier	Member ID
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Member Number identifier type Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MB
status	?!SΣ	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: Payer Type (extensible): US Public Health Data Consortium Source of Payment Codes
policyHolder	SΣ	0..1	Reference(CRD Patient | CRD Organization)	Owner of the policy
subscriber	SΣ	0..1	Reference(CRD Patient)	Subscriber to the policy
subscriberId	SΣC	0..1	string	ID assigned to the subscriber
beneficiary	SΣ	1..1	Reference(CRD Patient)	Plan beneficiary
dependent	SΣ	0..1	string	Dependent number
relationship	S	1..1	CodeableConcept	Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible)
period	SΣ	0..1	Period	Coverage start and end dates
payor	SΣ	1..1	Reference(CRD Patient | CRD Organization)	Issuer of the policy
Slices for class	S	0..*	BackboneElement	Additional coverage classifications Slice: Unordered, Open by pattern:type
class:All Slices				Content/Rules for all slices
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
class:group	S	0..1	BackboneElement	Group
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. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
code		1..1	code	Symbol in syntax defined by the system Fixed Value: group
value	SΣ	1..1	string	Group Number
name	SΣ	0..1	string	Group Name
class:plan	S	0..1	BackboneElement	Plan
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. Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
code		1..1	code	Symbol in syntax defined by the system Fixed Value: plan
value	SΣ	1..1	string	Plan Number
name	SΣ	0..1	string	Plan Name
order	SΣ	0..1	positiveInt	Relative order of the coverage
network	SΣ	0..1	string	Insurer network
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Coverage.identifier:memberid.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Coverage.identifier:memberid.type	extensible	Pattern: MB http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Coverage.status	required	FinancialResourceStatusCodes http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
Coverage.type	extensible	PayerType (a valid code from Source of Payment Typology (https://nahdo.org/sopt) http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591 from https://vsac.nlm.nih.gov
Coverage.relationship	extensible	SubscriberRelationshipCodes http://hl7.org/fhir/ValueSet/subscriber-relationship from the FHIR Standard
Coverage.class.type	extensible	CoverageClassCodes http://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard
Coverage.class:group.type	extensible	Pattern: group http://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard
Coverage.class:plan.type	extensible	Pattern: plan http://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Coverage	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	Coverage	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Coverage	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
us-core-15	error	Coverage	Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present : identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Coverage	C	0..*	USCoreCoverageProfile(7.0.0)	Insurance or medical plan or a payment agreement This profile also complies with the profile US Core Practitioner Profile (6.1.0) us-core-15: Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present
id	Σ	0..1	id	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): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
Slices for identifier	SΣ	0..*	Identifier	Member ID and other identifiers Slice: Unordered, Open by pattern:type
identifier:memberid	SΣC	0..1	Identifier	Member ID
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..1	CodeableConcept	Member Number identifier type Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MB
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!SΣ	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: Payer Type (extensible): US Public Health Data Consortium Source of Payment Codes
policyHolder	SΣ	0..1	Reference(CRD Patient | CRD Organization)	Owner of the policy
subscriber	SΣ	0..1	Reference(CRD Patient)	Subscriber to the policy
subscriberId	SΣC	0..1	string	ID assigned to the subscriber
beneficiary	SΣ	1..1	Reference(CRD Patient)	Plan beneficiary
dependent	SΣ	0..1	string	Dependent number
relationship	S	1..1	CodeableConcept	Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible)
period	SΣ	0..1	Period	Coverage start and end dates
payor	SΣ	1..1	Reference(CRD Patient | CRD Organization)	Issuer of the policy
Slices for class	S	0..*	BackboneElement	Additional coverage classifications Slice: Unordered, Open by pattern:type
class:All Slices				Content/Rules for all slices
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
class:group	S	0..1	BackboneElement	Group
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: group
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
value	SΣ	1..1	string	Group Number
name	SΣ	0..1	string	Group Name
class:plan	S	0..1	BackboneElement	Plan
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/coverage-class
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: plan
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
value	SΣ	1..1	string	Plan Number
name	SΣ	0..1	string	Plan Name
order	SΣ	0..1	positiveInt	Relative order of the coverage
network	SΣ	0..1	string	Insurer network
subrogation		0..1	boolean	Reimbursement to insurer
contract		0..*	Reference(Contract)	Contract details
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Coverage.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Coverage.identifier:memberid.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Coverage.identifier:memberid.type	extensible	Pattern: MB http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Coverage.status	required	FinancialResourceStatusCodes http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
Coverage.type	extensible	PayerType (a valid code from Source of Payment Typology (https://nahdo.org/sopt) http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591 from https://vsac.nlm.nih.gov
Coverage.relationship	extensible	SubscriberRelationshipCodes http://hl7.org/fhir/ValueSet/subscriber-relationship from the FHIR Standard
Coverage.class.type	extensible	CoverageClassCodes http://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard
Coverage.class:group.type	extensible	Pattern: group http://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard
Coverage.class:plan.type	extensible	Pattern: plan http://hl7.org/fhir/ValueSet/coverage-class from the FHIR Standard
Coverage.costToBeneficiary.type	extensible	CoverageCopayTypeCodes http://hl7.org/fhir/ValueSet/coverage-copay-type from the FHIR Standard
Coverage.costToBeneficiary.exception.type	example	ExampleCoverageFinancialExceptionCodes http://hl7.org/fhir/ValueSet/coverage-financial-exception from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Coverage	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	Coverage	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Coverage	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
us-core-15	error	Coverage	Member Id in Coverage.identifier or Coverage.subscriberId SHALL be present : identifier.type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='MB').exists() or subscriberId.exists()

This structure is derived from USCoreCoverageProfile

Summary

Must-Support: 5 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• CRD Patient (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-patient)
• CRD Organization (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-organization)

Maturity: 2

Other representations of profile: CSV, Excel, Schematron