Release 5 Preview #1
FinancialThis page is part of the FHIR Specification (v4.2.0: R5 Preview #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
| Financial Management Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Patient, Practitioner |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for coverageeligibilityresponse
{
"resourceType" : "StructureDefinition",
"id" : "CoverageEligibilityResponse",
"meta" : {
"lastUpdated" : "2019-12-31T21:03:40.621+11:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fm"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/CoverageEligibilityResponse",
"version" : "4.2.0",
"name" : "CoverageEligibilityResponse",
"status" : "draft",
"date" : "2019-12-31T21:03:40+11:00",
"publisher" : "Health Level Seven International (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" : "This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.",
"fhirVersion" : "4.2.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "cdanetv4",
"uri" : "http://www.cda-adc.ca/en/services/cdanet/",
"name" : "Canadian Dental Association eclaims standard"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "CoverageEligibilityResponse",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "CoverageEligibilityResponse",
"path" : "CoverageEligibilityResponse",
"short" : "CoverageEligibilityResponse resource",
"definition" : "This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CoverageEligibilityResponse",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "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()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
}]
},
{
"id" : "CoverageEligibilityResponse.id",
"path" : "CoverageEligibilityResponse.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CoverageEligibilityResponse.meta",
"path" : "CoverageEligibilityResponse.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 might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CoverageEligibilityResponse.implicitRules",
"path" : "CoverageEligibilityResponse.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "CoverageEligibilityResponse.language",
"path" : "CoverageEligibilityResponse.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "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. Not 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",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "CoverageEligibilityResponse.text",
"path" : "CoverageEligibilityResponse.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can 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.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "CoverageEligibilityResponse.contained",
"path" : "CoverageEligibilityResponse.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.",
"comment" : "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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CoverageEligibilityResponse.extension",
"path" : "CoverageEligibilityResponse.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. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CoverageEligibilityResponse.modifierExtension",
"path" : "CoverageEligibilityResponse.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CoverageEligibilityResponse.identifier",
"path" : "CoverageEligibilityResponse.identifier",
"short" : "Business Identifier for coverage eligiblity request",
"definition" : "A unique identifier assigned to this coverage eligiblity request.",
"requirements" : "Allows coverage eligibility requests to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CoverageEligibilityResponse.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CoverageEligibilityResponse.status",
"path" : "CoverageEligibilityResponse.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EligibilityResponseStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.2.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CoverageEligibilityResponse.purpose",
"path" : "CoverageEligibilityResponse.purpose",
"short" : "auth-requirements | benefits | discovery | validation",
"definition" : "Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.",
"requirements" : "To indicate the processing actions requested.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "CoverageEligibilityResponse.purpose",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EligibilityResponsePurpose"
}],
"strength" : "required",
"description" : "A code specifying the types of information being requested.",
"valueSet" : "http://hl7.org/fhir/ValueSet/eligibilityresponse-purpose|4.2.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CoverageEligibilityResponse.patient",
"path" : "CoverageEligibilityResponse.patient",
"short" : "Intended recipient of products and services",
"definition" : "The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.",
"requirements" : "Required to provide context and coverage validation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.patient",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "cdanetv4",
"map" : "C06,C07,C08, C05, C04"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "CoverageEligibilityResponse.serviced[x]",
"path" : "CoverageEligibilityResponse.serviced[x]",
"short" : "Estimated date or dates of service",
"definition" : "The date or dates when the enclosed suite of services were performed or completed.",
"requirements" : "Required to provide time context for the request.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.serviced[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
},
{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "cdanetv4",
"map" : "F09"
}]
},
{
"id" : "CoverageEligibilityResponse.created",
"path" : "CoverageEligibilityResponse.created",
"short" : "Response creation date",
"definition" : "The date this resource was created.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.created",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "CoverageEligibilityResponse.requestor",
"path" : "CoverageEligibilityResponse.requestor",
"short" : "Party responsible for the request",
"definition" : "The provider which is responsible for the request.",
"comment" : "Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.requestor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "cdanetv4",
"map" : "B01"
}]
},
{
"id" : "CoverageEligibilityResponse.request",
"path" : "CoverageEligibilityResponse.request",
"short" : "Eligibility request reference",
"definition" : "Reference to the original request resource.",
"requirements" : "Needed to allow the response to be linked to the request.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.request",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "cdanetv4",
"map" : "A02|G01"
}]
},
{
"id" : "CoverageEligibilityResponse.outcome",
"path" : "CoverageEligibilityResponse.outcome",
"short" : "queued | complete | error | partial",
"definition" : "The outcome of the request processing.",
"comment" : "The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).",
"requirements" : "To advise the requestor of an overall processing outcome.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.outcome",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RemittanceOutcome"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The outcome of the processing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/remittance-outcome|4.2.0"
}
},
{
"id" : "CoverageEligibilityResponse.disposition",
"path" : "CoverageEligibilityResponse.disposition",
"short" : "Disposition Message",
"definition" : "A human readable description of the status of the adjudication.",
"requirements" : "Provided for user display.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.disposition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
}]
},
{
"id" : "CoverageEligibilityResponse.insurer",
"path" : "CoverageEligibilityResponse.insurer",
"short" : "Coverage issuer",
"definition" : "The Insurer who issued the coverage in question and is the author of the response.",
"requirements" : "Need to identify the author.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurer",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CoverageEligibilityResponse.insurance",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "380;0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Insurance"
}],
"path" : "CoverageEligibilityResponse.insurance",
"short" : "Patient insurance information",
"definition" : "Financial instruments for reimbursement for the health care products and services.",
"comment" : "All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.",
"requirements" : "There must be at least one coverage for which eligibility is requested.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CoverageEligibilityResponse.insurance",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CoverageEligibilityResponse.insurance.id",
"path" : "CoverageEligibilityResponse.insurance.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.extension",
"path" : "CoverageEligibilityResponse.insurance.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 element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.modifierExtension",
"path" : "CoverageEligibilityResponse.insurance.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.coverage",
"path" : "CoverageEligibilityResponse.insurance.coverage",
"short" : "Insurance information",
"definition" : "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.",
"requirements" : "Required to allow the adjudicator to locate the correct policy and history within their information system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.coverage",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "CoverageEligibilityResponse.insurance.inforce",
"path" : "CoverageEligibilityResponse.insurance.inforce",
"short" : "Coverage inforce indicator",
"definition" : "Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.",
"requirements" : "Needed to convey the answer to the eligibility validation request.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.inforce",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CoverageEligibilityResponse.insurance.benefitPeriod",
"path" : "CoverageEligibilityResponse.insurance.benefitPeriod",
"short" : "When the benefits are applicable",
"definition" : "The term of the benefits documented in this response.",
"requirements" : "Needed as coverages may be multi-year while benefits tend to be annual therefore a separate expression of the benefit period is needed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.benefitPeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CoverageEligibilityResponse.insurance.item",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "340;120"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Items"
}],
"path" : "CoverageEligibilityResponse.insurance.item",
"short" : "Benefits and authorization details",
"definition" : "Benefits and optionally current balances, and authorization details by category or service.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ces-1",
"severity" : "error",
"human" : "SHALL contain a category or a billcode but not both.",
"expression" : "category.exists() xor productOrService.exists()",
"xpath" : "exists(f:category) or exists(f:productOrService)"
},
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CoverageEligibilityResponse.insurance.item.id",
"path" : "CoverageEligibilityResponse.insurance.item.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.extension",
"path" : "CoverageEligibilityResponse.insurance.item.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 element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.modifierExtension",
"path" : "CoverageEligibilityResponse.insurance.item.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.category",
"path" : "CoverageEligibilityResponse.insurance.item.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed to convey the category of service or product for which eligibility is sought.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral, medical, vision etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.productOrService",
"path" : "CoverageEligibilityResponse.insurance.item.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "This contains the product, service, drug or other billing code for the item.",
"comment" : "Code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI).",
"requirements" : "Needed to convey the actual service or product for which eligibility is sought.",
"alias" : ["Drug Code",
"Bill Code",
"Service Code"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.productOrService",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.modifier",
"path" : "CoverageEligibilityResponse.insurance.item.modifier",
"short" : "Product or service billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.",
"requirements" : "To support provision of the item or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.modifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.provider",
"path" : "CoverageEligibilityResponse.insurance.item.provider",
"short" : "Performing practitioner",
"definition" : "The practitioner who is eligible for the provision of the product or service.",
"requirements" : "Needed to convey the eligible provider.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.provider",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "cdanetv4",
"map" : "B01"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.excluded",
"path" : "CoverageEligibilityResponse.insurance.item.excluded",
"short" : "Excluded from the plan",
"definition" : "True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.",
"requirements" : "Needed to identify items that are specifically excluded from the coverage.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.excluded",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CoverageEligibilityResponse.insurance.item.name",
"path" : "CoverageEligibilityResponse.insurance.item.name",
"short" : "Short name for the benefit",
"definition" : "A short name or tag for the benefit.",
"comment" : "For example: MED01, or DENT2.",
"requirements" : "Required to align with other plan names.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CoverageEligibilityResponse.insurance.item.description",
"path" : "CoverageEligibilityResponse.insurance.item.description",
"short" : "Description of the benefit or services covered",
"definition" : "A richer description of the benefit or services covered.",
"comment" : "For example 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'.",
"requirements" : "Needed for human readable reference.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CoverageEligibilityResponse.insurance.item.network",
"path" : "CoverageEligibilityResponse.insurance.item.network",
"short" : "In or out of network",
"definition" : "Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.",
"requirements" : "Needed as in or out of network providers are treated differently under the coverage.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.network",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitNetwork"
}],
"strength" : "example",
"description" : "Code to classify in or out of network services.",
"valueSet" : "http://hl7.org/fhir/ValueSet/benefit-network"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.unit",
"path" : "CoverageEligibilityResponse.insurance.item.unit",
"short" : "Individual or family",
"definition" : "Indicates if the benefits apply to an individual or to the family.",
"requirements" : "Needed for the understanding of the benefits.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.unit",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitUnit"
}],
"strength" : "example",
"description" : "Unit covered/serviced - individual or family.",
"valueSet" : "http://hl7.org/fhir/ValueSet/benefit-unit"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.term",
"path" : "CoverageEligibilityResponse.insurance.item.term",
"short" : "Annual or lifetime",
"definition" : "The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.",
"requirements" : "Needed for the understanding of the benefits.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.term",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitTerm"
}],
"strength" : "example",
"description" : "Coverage unit - annual, lifetime.",
"valueSet" : "http://hl7.org/fhir/ValueSet/benefit-term"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.benefit",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "340;320"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Benefit"
}],
"path" : "CoverageEligibilityResponse.insurance.item.benefit",
"short" : "Benefit Summary",
"definition" : "Benefits used to date.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.benefit",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CoverageEligibilityResponse.insurance.item.benefit.id",
"path" : "CoverageEligibilityResponse.insurance.item.benefit.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.benefit.extension",
"path" : "CoverageEligibilityResponse.insurance.item.benefit.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 element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.benefit.modifierExtension",
"path" : "CoverageEligibilityResponse.insurance.item.benefit.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.benefit.type",
"path" : "CoverageEligibilityResponse.insurance.item.benefit.type",
"short" : "Benefit classification",
"definition" : "Classification of benefit being provided.",
"comment" : "For example: deductible, visits, benefit amount.",
"requirements" : "Needed to convey the nature of the benefit.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.benefit.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitType"
}],
"strength" : "example",
"description" : "Deductable, visits, co-pay, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/benefit-type"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.benefit.allowed[x]",
"path" : "CoverageEligibilityResponse.insurance.item.benefit.allowed[x]",
"short" : "Benefits allowed",
"definition" : "The quantity of the benefit which is permitted under the coverage.",
"requirements" : "Needed to convey the benefits offered under the coverage.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.benefit.allowed[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "unsignedInt"
},
{
"code" : "string"
},
{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CoverageEligibilityResponse.insurance.item.benefit.used[x]",
"path" : "CoverageEligibilityResponse.insurance.item.benefit.used[x]",
"short" : "Benefits used",
"definition" : "The quantity of the benefit which have been consumed to date.",
"requirements" : "Needed to convey the benefits consumed to date.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.benefit.used[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "unsignedInt"
},
{
"code" : "string"
},
{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CoverageEligibilityResponse.insurance.item.authorizationRequired",
"path" : "CoverageEligibilityResponse.insurance.item.authorizationRequired",
"short" : "Authorization required flag",
"definition" : "A boolean flag indicating whether a preauthorization is required prior to actual service delivery.",
"requirements" : "Needed to convey that preauthorization is required.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.authorizationRequired",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CoverageEligibilityResponse.insurance.item.authorizationSupporting",
"path" : "CoverageEligibilityResponse.insurance.item.authorizationSupporting",
"short" : "Type of required supporting materials",
"definition" : "Codes or comments regarding information or actions associated with the preauthorization.",
"requirements" : "Needed to inform the provider of collateral materials or actions needed for preauthorization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.authorizationSupporting",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuthSupporting"
}],
"strength" : "example",
"description" : "Type of supporting information to provide with a preauthorization.",
"valueSet" : "http://hl7.org/fhir/ValueSet/coverageeligibilityresponse-ex-auth-support"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.authorizationUrl",
"path" : "CoverageEligibilityResponse.insurance.item.authorizationUrl",
"short" : "Preauthorization requirements endpoint",
"definition" : "A web location for obtaining requirements or descriptive information regarding the preauthorization.",
"requirements" : "Needed to enable insurers to advise providers of informative information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.insurance.item.authorizationUrl",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CoverageEligibilityResponse.preAuthRef",
"path" : "CoverageEligibilityResponse.preAuthRef",
"short" : "Preauthorization reference",
"definition" : "A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.",
"requirements" : "To provide any preauthorization reference for provider use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.preAuthRef",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "cdanetv4",
"map" : "F03"
},
{
"identity" : "rim",
"map" : "23"
}]
},
{
"id" : "CoverageEligibilityResponse.form",
"path" : "CoverageEligibilityResponse.form",
"short" : "Printed form identifier",
"definition" : "A code for the form to be used for printing the content.",
"comment" : "May be needed to identify specific jurisdictional forms.",
"requirements" : "Needed to specify the specific form used for producing output for this response.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.form",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Forms"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "The forms codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/forms"
},
"mapping" : [{
"identity" : "cdanetv4",
"map" : "G42"
}]
},
{
"id" : "CoverageEligibilityResponse.error",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Errors"
}],
"path" : "CoverageEligibilityResponse.error",
"short" : "Processing errors",
"definition" : "Errors encountered during the processing of the request.",
"requirements" : "Need to communicate processing issues to the requestor.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CoverageEligibilityResponse.error",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "CoverageEligibilityResponse.error.id",
"path" : "CoverageEligibilityResponse.error.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CoverageEligibilityResponse.error.extension",
"path" : "CoverageEligibilityResponse.error.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 element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "CoverageEligibilityResponse.error.modifierExtension",
"path" : "CoverageEligibilityResponse.error.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "CoverageEligibilityResponse.error.code",
"path" : "CoverageEligibilityResponse.error.code",
"short" : "Error code detailing processing issues",
"definition" : "An error code,from a specified code system, which details why the eligibility check could not be performed.",
"requirements" : "Required to convey processing errors.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CoverageEligibilityResponse.error.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdjudicationError"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "The error codes for adjudication processing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adjudication-error"
}
}]
},
"differential" : {
"element" : [{
"id" : "CoverageEligibilityResponse",
"path" : "CoverageEligibilityResponse",
"short" : "CoverageEligibilityResponse resource",
"definition" : "This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
}]
},
{
"id" : "CoverageEligibilityResponse.identifier",
"path" : "CoverageEligibilityResponse.identifier",
"short" : "Business Identifier for coverage eligiblity request",
"definition" : "A unique identifier assigned to this coverage eligiblity request.",
"requirements" : "Allows coverage eligibility requests to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "CoverageEligibilityResponse.status",
"path" : "CoverageEligibilityResponse.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EligibilityResponseStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.2.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "CoverageEligibilityResponse.purpose",
"path" : "CoverageEligibilityResponse.purpose",
"short" : "auth-requirements | benefits | discovery | validation",
"definition" : "Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.",
"requirements" : "To indicate the processing actions requested.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EligibilityResponsePurpose"
}],
"strength" : "required",
"description" : "A code specifying the types of information being requested.",
"valueSet" : "http://hl7.org/fhir/ValueSet/eligibilityresponse-purpose|4.2.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "CoverageEligibilityResponse.patient",
"path" : "CoverageEligibilityResponse.patient",
"short" : "Intended recipient of products and services",
"definition" : "The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.",
"requirements" : "Required to provide context and coverage validation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "cdanetv4",
"map" : "C06,C07,C08, C05, C04"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "CoverageEligibilityResponse.serviced[x]",
"path" : "CoverageEligibilityResponse.serviced[x]",
"short" : "Estimated date or dates of service",
"definition" : "The date or dates when the enclosed suite of services were performed or completed.",
"requirements" : "Required to provide time context for the request.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
},
{
"code" : "Period"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "cdanetv4",
"map" : "F09"
}]
},
{
"id" : "CoverageEligibilityResponse.created",
"path" : "CoverageEligibilityResponse.created",
"short" : "Response creation date",
"definition" : "The date this resource was created.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "CoverageEligibilityResponse.requestor",
"path" : "CoverageEligibilityResponse.requestor",
"short" : "Party responsible for the request",
"definition" : "The provider which is responsible for the request.",
"comment" : "Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "cdanetv4",
"map" : "B01"
}]
},
{
"id" : "CoverageEligibilityResponse.request",
"path" : "CoverageEligibilityResponse.request",
"short" : "Eligibility request reference",
"definition" : "Reference to the original request resource.",
"requirements" : "Needed to allow the response to be linked to the request.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "cdanetv4",
"map" : "A02|G01"
}]
},
{
"id" : "CoverageEligibilityResponse.outcome",
"path" : "CoverageEligibilityResponse.outcome",
"short" : "queued | complete | error | partial",
"definition" : "The outcome of the request processing.",
"comment" : "The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).",
"requirements" : "To advise the requestor of an overall processing outcome.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RemittanceOutcome"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The outcome of the processing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/remittance-outcome|4.2.0"
}
},
{
"id" : "CoverageEligibilityResponse.disposition",
"path" : "CoverageEligibilityResponse.disposition",
"short" : "Disposition Message",
"definition" : "A human readable description of the status of the adjudication.",
"requirements" : "Provided for user display.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
}]
},
{
"id" : "CoverageEligibilityResponse.insurer",
"path" : "CoverageEligibilityResponse.insurer",
"short" : "Coverage issuer",
"definition" : "The Insurer who issued the coverage in question and is the author of the response.",
"requirements" : "Need to identify the author.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "CoverageEligibilityResponse.insurance",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "380;0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Insurance"
}],
"path" : "CoverageEligibilityResponse.insurance",
"short" : "Patient insurance information",
"definition" : "Financial instruments for reimbursement for the health care products and services.",
"comment" : "All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.",
"requirements" : "There must be at least one coverage for which eligibility is requested.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.coverage",
"path" : "CoverageEligibilityResponse.insurance.coverage",
"short" : "Insurance information",
"definition" : "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.",
"requirements" : "Required to allow the adjudicator to locate the correct policy and history within their information system.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage"]
}],
"isSummary" : true
},
{
"id" : "CoverageEligibilityResponse.insurance.inforce",
"path" : "CoverageEligibilityResponse.insurance.inforce",
"short" : "Coverage inforce indicator",
"definition" : "Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.",
"requirements" : "Needed to convey the answer to the eligibility validation request.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.benefitPeriod",
"path" : "CoverageEligibilityResponse.insurance.benefitPeriod",
"short" : "When the benefits are applicable",
"definition" : "The term of the benefits documented in this response.",
"requirements" : "Needed as coverages may be multi-year while benefits tend to be annual therefore a separate expression of the benefit period is needed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "340;120"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Items"
}],
"path" : "CoverageEligibilityResponse.insurance.item",
"short" : "Benefits and authorization details",
"definition" : "Benefits and optionally current balances, and authorization details by category or service.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ces-1",
"severity" : "error",
"human" : "SHALL contain a category or a billcode but not both.",
"expression" : "category.exists() xor productOrService.exists()",
"xpath" : "exists(f:category) or exists(f:productOrService)"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.category",
"path" : "CoverageEligibilityResponse.insurance.item.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed to convey the category of service or product for which eligibility is sought.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral, medical, vision etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.productOrService",
"path" : "CoverageEligibilityResponse.insurance.item.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "This contains the product, service, drug or other billing code for the item.",
"comment" : "Code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI).",
"requirements" : "Needed to convey the actual service or product for which eligibility is sought.",
"alias" : ["Drug Code",
"Bill Code",
"Service Code"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.modifier",
"path" : "CoverageEligibilityResponse.insurance.item.modifier",
"short" : "Product or service billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.",
"requirements" : "To support provision of the item or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.provider",
"path" : "CoverageEligibilityResponse.insurance.item.provider",
"short" : "Performing practitioner",
"definition" : "The practitioner who is eligible for the provision of the product or service.",
"requirements" : "Needed to convey the eligible provider.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "cdanetv4",
"map" : "B01"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.excluded",
"path" : "CoverageEligibilityResponse.insurance.item.excluded",
"short" : "Excluded from the plan",
"definition" : "True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.",
"requirements" : "Needed to identify items that are specifically excluded from the coverage.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.name",
"path" : "CoverageEligibilityResponse.insurance.item.name",
"short" : "Short name for the benefit",
"definition" : "A short name or tag for the benefit.",
"comment" : "For example: MED01, or DENT2.",
"requirements" : "Required to align with other plan names.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.description",
"path" : "CoverageEligibilityResponse.insurance.item.description",
"short" : "Description of the benefit or services covered",
"definition" : "A richer description of the benefit or services covered.",
"comment" : "For example 'DENT2 covers 100% of basic, 50% of major but excludes Ortho, Implants and Cosmetic services'.",
"requirements" : "Needed for human readable reference.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.network",
"path" : "CoverageEligibilityResponse.insurance.item.network",
"short" : "In or out of network",
"definition" : "Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.",
"requirements" : "Needed as in or out of network providers are treated differently under the coverage.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitNetwork"
}],
"strength" : "example",
"description" : "Code to classify in or out of network services.",
"valueSet" : "http://hl7.org/fhir/ValueSet/benefit-network"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.unit",
"path" : "CoverageEligibilityResponse.insurance.item.unit",
"short" : "Individual or family",
"definition" : "Indicates if the benefits apply to an individual or to the family.",
"requirements" : "Needed for the understanding of the benefits.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitUnit"
}],
"strength" : "example",
"description" : "Unit covered/serviced - individual or family.",
"valueSet" : "http://hl7.org/fhir/ValueSet/benefit-unit"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.term",
"path" : "CoverageEligibilityResponse.insurance.item.term",
"short" : "Annual or lifetime",
"definition" : "The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.",
"requirements" : "Needed for the understanding of the benefits.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitTerm"
}],
"strength" : "example",
"description" : "Coverage unit - annual, lifetime.",
"valueSet" : "http://hl7.org/fhir/ValueSet/benefit-term"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.benefit",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "340;320"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Benefit"
}],
"path" : "CoverageEligibilityResponse.insurance.item.benefit",
"short" : "Benefit Summary",
"definition" : "Benefits used to date.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.benefit.type",
"path" : "CoverageEligibilityResponse.insurance.item.benefit.type",
"short" : "Benefit classification",
"definition" : "Classification of benefit being provided.",
"comment" : "For example: deductible, visits, benefit amount.",
"requirements" : "Needed to convey the nature of the benefit.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitType"
}],
"strength" : "example",
"description" : "Deductable, visits, co-pay, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/benefit-type"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.benefit.allowed[x]",
"path" : "CoverageEligibilityResponse.insurance.item.benefit.allowed[x]",
"short" : "Benefits allowed",
"definition" : "The quantity of the benefit which is permitted under the coverage.",
"requirements" : "Needed to convey the benefits offered under the coverage.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "unsignedInt"
},
{
"code" : "string"
},
{
"code" : "Money"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.benefit.used[x]",
"path" : "CoverageEligibilityResponse.insurance.item.benefit.used[x]",
"short" : "Benefits used",
"definition" : "The quantity of the benefit which have been consumed to date.",
"requirements" : "Needed to convey the benefits consumed to date.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "unsignedInt"
},
{
"code" : "string"
},
{
"code" : "Money"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.authorizationRequired",
"path" : "CoverageEligibilityResponse.insurance.item.authorizationRequired",
"short" : "Authorization required flag",
"definition" : "A boolean flag indicating whether a preauthorization is required prior to actual service delivery.",
"requirements" : "Needed to convey that preauthorization is required.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "CoverageEligibilityResponse.insurance.item.authorizationSupporting",
"path" : "CoverageEligibilityResponse.insurance.item.authorizationSupporting",
"short" : "Type of required supporting materials",
"definition" : "Codes or comments regarding information or actions associated with the preauthorization.",
"requirements" : "Needed to inform the provider of collateral materials or actions needed for preauthorization.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AuthSupporting"
}],
"strength" : "example",
"description" : "Type of supporting information to provide with a preauthorization.",
"valueSet" : "http://hl7.org/fhir/ValueSet/coverageeligibilityresponse-ex-auth-support"
}
},
{
"id" : "CoverageEligibilityResponse.insurance.item.authorizationUrl",
"path" : "CoverageEligibilityResponse.insurance.item.authorizationUrl",
"short" : "Preauthorization requirements endpoint",
"definition" : "A web location for obtaining requirements or descriptive information regarding the preauthorization.",
"requirements" : "Needed to enable insurers to advise providers of informative information.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}]
},
{
"id" : "CoverageEligibilityResponse.preAuthRef",
"path" : "CoverageEligibilityResponse.preAuthRef",
"short" : "Preauthorization reference",
"definition" : "A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.",
"requirements" : "To provide any preauthorization reference for provider use.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "cdanetv4",
"map" : "F03"
},
{
"identity" : "rim",
"map" : "23"
}]
},
{
"id" : "CoverageEligibilityResponse.form",
"path" : "CoverageEligibilityResponse.form",
"short" : "Printed form identifier",
"definition" : "A code for the form to be used for printing the content.",
"comment" : "May be needed to identify specific jurisdictional forms.",
"requirements" : "Needed to specify the specific form used for producing output for this response.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Forms"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "The forms codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/forms"
},
"mapping" : [{
"identity" : "cdanetv4",
"map" : "G42"
}]
},
{
"id" : "CoverageEligibilityResponse.error",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Errors"
}],
"path" : "CoverageEligibilityResponse.error",
"short" : "Processing errors",
"definition" : "Errors encountered during the processing of the request.",
"requirements" : "Need to communicate processing issues to the requestor.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "CoverageEligibilityResponse.error.code",
"path" : "CoverageEligibilityResponse.error.code",
"short" : "Error code detailing processing issues",
"definition" : "An error code,from a specified code system, which details why the eligibility check could not be performed.",
"requirements" : "Required to convey processing errors.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdjudicationError"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "The error codes for adjudication processing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/adjudication-error"
}
}]
}
}
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.
FHIR ®© HL7.org 2011+. FHIR CI Build hl7.fhir.core#4.2.0 (GitHub f996518d66) generated on Tue, Dec 31, 2019 21:11+1100.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change