. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
StructureDefinition for coverage
{
"resourceType": "StructureDefinition",
"id": "Coverage",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Coverage",
"name": "Coverage",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Coverage Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "cpha3pharm",
"uri": "http://www.pharmacists.ca/",
"name": "Canadian Pharmacy Associaiton eclaims standard"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Coverage",
"short": "Insurance or medical plan",
"definition": "Financial instrument which may be used to pay for or reimburse for health care products and services.",
"requirements": "Health care programs and insurers are significant payors of health service costs.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coverage"
}
],
"mapping": [
{
"identity": "rim",
"map": "Coverage"
}
]
},
{
"path": "Coverage.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Coverage.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Coverage.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Coverage.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource\n\nNot all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Coverage.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Coverage.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Coverage.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Coverage.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Coverage.issuer",
"short": "An identifier for the plan issuer",
"definition": "The program or plan underwriter or payor.",
"requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.30"
},
{
"identity": "v2",
"map": "IN1-3-insurance company ID"
},
{
"identity": "cdanetv4",
"map": "A05"
}
]
},
{
"path": "Coverage.bin",
"short": "BIN Number",
"definition": "Business Identification Number (BIN number) used to identify the routing of eclaims if the insurer themselves don't have a BIN number for all of their business.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "Coverage.period",
"short": "Coverage start and end dates",
"definition": "Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IN1-12-plan effective date / IN1-13-plan expiration date"
}
]
},
{
"path": "Coverage.type",
"short": "Type of coverage",
"definition": "The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.",
"requirements": "The order of application of coverages is dependent on the types of coverage.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"name": "CoverageType",
"strength": "example",
"description": "The type of insurance: public health, worker compensation; private accident, auto, private health, etc.)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ActCoverageTypeCode"
}
},
"mapping": [
{
"identity": "v2",
"map": "IN1-15-plan type"
}
]
},
{
"path": "Coverage.subscriberId",
"short": "Subscriber ID",
"definition": "The id issued to the subscriber.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "Coverage.identifier",
"short": "The primary coverage ID",
"definition": "The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Subscriber Id, Certificate number or Personal Health Number or Case ID.",
"requirements": "This value may uniquely identify the coverage or it may be used in conjunction with the additional identifiers below.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.32, C.33, C.39"
},
{
"identity": "v2",
"map": "IN1-2-health plan ID"
},
{
"identity": "cdanetv4",
"map": "C02"
}
]
},
{
"path": "Coverage.group",
"short": "An identifier for the group",
"definition": "Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.31"
},
{
"identity": "v2",
"map": "IN1-8-group number"
},
{
"identity": "cdanetv4",
"map": "C11 (Division,Section)"
}
]
},
{
"path": "Coverage.plan",
"short": "An identifier for the plan",
"definition": "Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IN1-35-company plan code"
},
{
"identity": "cdanetv4",
"map": "C01"
}
]
},
{
"path": "Coverage.subPlan",
"short": "An identifier for the subsection of the plan",
"definition": "Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a specific employer group within a class of employers. May be referred to as a Section or Division ID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IN1-10-insured's group emp ID"
}
]
},
{
"path": "Coverage.dependent",
"short": "The dependent number",
"definition": "A unique identifier for a dependent under the coverage.",
"requirements": "For some coverage a single identifier is issued to the PolicyHolder and dependent number issues to each to each of their dependents to track and manage the plan.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "- No exact V2.x equivalent concept seems to exist; instance relationship can be inferred if ( ( PID-3-patient ID list ??? IN1-49-insured's ID number ) & ( ?? IN2-72-patient's relationship to insured ) )"
},
{
"identity": "cdanetv4",
"map": "C17"
}
]
},
{
"path": "Coverage.sequence",
"short": "The plan instance or sequence counter",
"definition": "An optional counter for a particular instance of the identified coverage which increments upon each renewal.",
"requirements": "Some coverage, for example social plans, may be offered in short time increments, for example for a week or a month at a time, so while the rest of the plan details and identifiers may remain constant over time, the instance is incremented with each renewal and provided to the covered party on their 'card'.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "No V2.x equivalent concept seems to exist"
},
{
"identity": "cdanetv4",
"map": "D11"
}
]
},
{
"path": "Coverage.subscriber",
"short": "Plan holder information",
"definition": "The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.35"
},
{
"identity": "v2",
"map": "IN1-16, 18, 19-name of insured, address, date of birth"
},
{
"identity": "cdanetv4",
"map": "D01 through D09"
}
]
},
{
"path": "Coverage.network",
"short": "Insurer network",
"definition": "The identifier for a community of providers.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cdanetv4",
"map": "D10"
}
]
},
{
"path": "Coverage.contract",
"short": "Contract details",
"definition": "The policy(s) which constitute this insurance coverage.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Contract"
}
],
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.35"
},
{
"identity": "v2",
"map": "IN1-16, 18, 19-name of insured, address, date of birth"
},
{
"identity": "cdanetv4",
"map": "D01 through D09"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Coverage",
"short": "Insurance or medical plan",
"definition": "Financial instrument which may be used to pay for or reimburse for health care products and services.",
"requirements": "Health care programs and insurers are significant payors of health service costs.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Coverage"
}
]
},
{
"path": "Coverage.issuer",
"short": "An identifier for the plan issuer",
"definition": "The program or plan underwriter or payor.",
"requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.30"
},
{
"identity": "v2",
"map": "IN1-3-insurance company ID"
},
{
"identity": "cdanetv4",
"map": "A05"
}
]
},
{
"path": "Coverage.bin",
"short": "BIN Number",
"definition": "Business Identification Number (BIN number) used to identify the routing of eclaims if the insurer themselves don't have a BIN number for all of their business.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "Coverage.period",
"short": "Coverage start and end dates",
"definition": "Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IN1-12-plan effective date / IN1-13-plan expiration date"
}
]
},
{
"path": "Coverage.type",
"short": "Type of coverage",
"definition": "The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.",
"requirements": "The order of application of coverages is dependent on the types of coverage.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"name": "CoverageType",
"strength": "example",
"description": "The type of insurance: public health, worker compensation; private accident, auto, private health, etc.)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ActCoverageTypeCode"
}
},
"mapping": [
{
"identity": "v2",
"map": "IN1-15-plan type"
}
]
},
{
"path": "Coverage.subscriberId",
"short": "Subscriber ID",
"definition": "The id issued to the subscriber.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "Coverage.identifier",
"short": "The primary coverage ID",
"definition": "The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Subscriber Id, Certificate number or Personal Health Number or Case ID.",
"requirements": "This value may uniquely identify the coverage or it may be used in conjunction with the additional identifiers below.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.32, C.33, C.39"
},
{
"identity": "v2",
"map": "IN1-2-health plan ID"
},
{
"identity": "cdanetv4",
"map": "C02"
}
]
},
{
"path": "Coverage.group",
"short": "An identifier for the group",
"definition": "Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.31"
},
{
"identity": "v2",
"map": "IN1-8-group number"
},
{
"identity": "cdanetv4",
"map": "C11 (Division,Section)"
}
]
},
{
"path": "Coverage.plan",
"short": "An identifier for the plan",
"definition": "Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IN1-35-company plan code"
},
{
"identity": "cdanetv4",
"map": "C01"
}
]
},
{
"path": "Coverage.subPlan",
"short": "An identifier for the subsection of the plan",
"definition": "Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a specific employer group within a class of employers. May be referred to as a Section or Division ID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IN1-10-insured's group emp ID"
}
]
},
{
"path": "Coverage.dependent",
"short": "The dependent number",
"definition": "A unique identifier for a dependent under the coverage.",
"requirements": "For some coverage a single identifier is issued to the PolicyHolder and dependent number issues to each to each of their dependents to track and manage the plan.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "- No exact V2.x equivalent concept seems to exist; instance relationship can be inferred if ( ( PID-3-patient ID list ??? IN1-49-insured's ID number ) & ( ?? IN2-72-patient's relationship to insured ) )"
},
{
"identity": "cdanetv4",
"map": "C17"
}
]
},
{
"path": "Coverage.sequence",
"short": "The plan instance or sequence counter",
"definition": "An optional counter for a particular instance of the identified coverage which increments upon each renewal.",
"requirements": "Some coverage, for example social plans, may be offered in short time increments, for example for a week or a month at a time, so while the rest of the plan details and identifiers may remain constant over time, the instance is incremented with each renewal and provided to the covered party on their 'card'.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "No V2.x equivalent concept seems to exist"
},
{
"identity": "cdanetv4",
"map": "D11"
}
]
},
{
"path": "Coverage.subscriber",
"short": "Plan holder information",
"definition": "The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.35"
},
{
"identity": "v2",
"map": "IN1-16, 18, 19-name of insured, address, date of birth"
},
{
"identity": "cdanetv4",
"map": "D01 through D09"
}
]
},
{
"path": "Coverage.network",
"short": "Insurer network",
"definition": "The identifier for a community of providers.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cdanetv4",
"map": "D10"
}
]
},
{
"path": "Coverage.contract",
"short": "Contract details",
"definition": "The policy(s) which constitute this insurance coverage.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Contract"
}
],
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.35"
},
{
"identity": "v2",
"map": "IN1-16, 18, 19-name of insured, address, date of birth"
},
{
"identity": "cdanetv4",
"map": "D01 through D09"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU (v0.4.0-4902) generated on Fri, Mar 27, 2015 00:19+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change