STU 3 Ballot
FinancialThis page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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: R3 R2
StructureDefinition for eligibilityresponse
{
"resourceType": "StructureDefinition",
"id": "EligibilityResponse",
"meta": {
"lastUpdated": "2016-08-11T17:02:54.322+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}
],
"url": "http://hl7.org/fhir/StructureDefinition/EligibilityResponse",
"name": "EligibilityResponse",
"status": "draft",
"publisher": "Health Level Seven International (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"date": "2016-08-11T17:02:54+10:00",
"description": "Base StructureDefinition for EligibilityResponse Resource",
"fhirVersion": "1.6.0",
"mapping": [
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 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": "EligibilityResponse",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "EligibilityResponse",
"path": "EligibilityResponse",
"short": "EligibilityResponse resource",
"definition": "This resource provides eligibility and plan details from the processing of an Eligibility resource.",
"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)"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)"
},
{
"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))"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "w5",
"map": "financial.support"
}
]
},
{
"id": "EligibilityResponse.id",
"path": "EligibilityResponse.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.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "EligibilityResponse.meta",
"path": "EligibilityResponse.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "EligibilityResponse.implicitRules",
"path": "EligibilityResponse.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "EligibilityResponse.language",
"path": "EligibilityResponse.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource 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": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "EligibilityResponse.text",
"path": "EligibilityResponse.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. 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 in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "EligibilityResponse.contained",
"path": "EligibilityResponse.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "EligibilityResponse.extension",
"path": "EligibilityResponse.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "EligibilityResponse.modifierExtension",
"path": "EligibilityResponse.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "EligibilityResponse.identifier",
"path": "EligibilityResponse.identifier",
"short": "Business Identifier",
"definition": "The Response business identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "EligibilityResponse.status",
"path": "EligibilityResponse.status",
"short": "active | cancelled | draft | entered-in-error",
"definition": "The status of the resource instance.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "A code specifying the state of the resource instance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/eligibilityresponse-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "EligibilityResponse.request[x]",
"path": "EligibilityResponse.request[x]",
"short": "Claim reference",
"definition": "Original request resource reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/EligibilityRequest"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "EligibilityResponse.outcome",
"path": "EligibilityResponse.outcome",
"short": "complete | error | partial",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The outcome of the processing.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/remittance-outcome"
}
}
},
{
"id": "EligibilityResponse.disposition",
"path": "EligibilityResponse.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "EligibilityResponse.ruleset",
"path": "EligibilityResponse.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "The static and dynamic model to which contents conform, which may be business version or standard/version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ruleset"
}
},
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "EligibilityResponse.originalRuleset",
"path": "EligibilityResponse.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "The static and dynamic model to which contents conform, which may be business version or standard/version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ruleset"
}
}
},
{
"id": "EligibilityResponse.created",
"path": "EligibilityResponse.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "EligibilityResponse.organization[x]",
"path": "EligibilityResponse.organization[x]",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"id": "EligibilityResponse.requestProvider[x]",
"path": "EligibilityResponse.requestProvider[x]",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "EligibilityResponse.requestOrganization[x]",
"path": "EligibilityResponse.requestOrganization[x]",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "EligibilityResponse.inforce",
"path": "EligibilityResponse.inforce",
"short": "Coverage inforce",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "EligibilityResponse.contract",
"path": "EligibilityResponse.contract",
"short": "Contract details",
"definition": "The contract resource which may provide more detailed information.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Contract"
}
]
},
{
"id": "EligibilityResponse.form",
"path": "EligibilityResponse.form",
"short": "Printed Form Identifier",
"definition": "The form to be used for printing the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "required",
"description": "The forms codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/forms"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "G42"
}
]
},
{
"id": "EligibilityResponse.benefitBalance",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Benefits"
}
],
"path": "EligibilityResponse.benefitBalance",
"short": "Benefits by Category",
"definition": "Benefits and optionally current balances by Category.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.id",
"path": "EligibilityResponse.benefitBalance.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.extension",
"path": "EligibilityResponse.benefitBalance.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.modifierExtension",
"path": "EligibilityResponse.benefitBalance.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.category",
"path": "EligibilityResponse.benefitBalance.category",
"short": "Benefit Category",
"definition": "Dental, Vision, Medical, Pharmacy, Rehab etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "Benefit categories such as: oral, medical, vision etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-category"
}
}
},
{
"id": "EligibilityResponse.benefitBalance.subCategory",
"path": "EligibilityResponse.benefitBalance.subCategory",
"short": "Benefit SubCategory",
"definition": "Dental: basic, major, ortho; Vision exam, glasses, contacts; etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "Benefit subcategories such as: oral-basic, major, glasses",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory"
}
}
},
{
"id": "EligibilityResponse.benefitBalance.name",
"path": "EligibilityResponse.benefitBalance.name",
"short": "Short name for the benefit",
"definition": "A short name or tag for the benefit, for example MED01, or DENT2.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.description",
"path": "EligibilityResponse.benefitBalance.description",
"short": "Description of the benefit",
"definition": "A richer description of the benefit, for example 'DENT2 covers 100% of basic, 50% of major but exclused Ortho, Implants and Costmetic services'.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.network",
"path": "EligibilityResponse.benefitBalance.network",
"short": "In or out of network",
"definition": "Network designation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "Code to classify in or out of network services",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-network"
}
}
},
{
"id": "EligibilityResponse.benefitBalance.unit",
"path": "EligibilityResponse.benefitBalance.unit",
"short": "Individual or family",
"definition": "Unit designation: individual or family.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "Unit covered/serviced - individual or family",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-unit"
}
}
},
{
"id": "EligibilityResponse.benefitBalance.term",
"path": "EligibilityResponse.benefitBalance.term",
"short": "Annual or lifetime",
"definition": "The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual vistis'.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "Coverage unit - annual, lifetime",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-term"
}
}
},
{
"id": "EligibilityResponse.benefitBalance.financial",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Benefit"
}
],
"path": "EligibilityResponse.benefitBalance.financial",
"short": "Benefit Summary",
"definition": "Benefits Used to date.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.financial.id",
"path": "EligibilityResponse.benefitBalance.financial.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.financial.extension",
"path": "EligibilityResponse.benefitBalance.financial.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.financial.modifierExtension",
"path": "EligibilityResponse.benefitBalance.financial.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.financial.type",
"path": "EligibilityResponse.benefitBalance.financial.type",
"short": "Deductable, visits, benefit amount",
"definition": "Deductable, visits, benefit amount.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "Deductable, visits, co-pay, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-type"
}
}
},
{
"id": "EligibilityResponse.benefitBalance.financial.benefit[x]",
"path": "EligibilityResponse.benefitBalance.financial.benefit[x]",
"short": "Benefits allowed",
"definition": "Benefits allowed.",
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
},
{
"code": "string"
},
{
"code": "Money"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.financial.benefitUsed[x]",
"path": "EligibilityResponse.benefitBalance.financial.benefitUsed[x]",
"short": "Benefits used",
"definition": "Benefits used.",
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
},
{
"code": "Money"
}
]
},
{
"id": "EligibilityResponse.error",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Errors"
}
],
"path": "EligibilityResponse.error",
"short": "Processing errors",
"definition": "Mutually exclusive with Services Provided (Item).",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "EligibilityResponse.error.id",
"path": "EligibilityResponse.error.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "EligibilityResponse.error.extension",
"path": "EligibilityResponse.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "EligibilityResponse.error.modifierExtension",
"path": "EligibilityResponse.error.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "EligibilityResponse.error.code",
"path": "EligibilityResponse.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.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "required",
"description": "The error codes for adjudication processing.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/adjudication-error"
}
}
}
]
},
"differential": {
"element": [
{
"id": "EligibilityResponse",
"path": "EligibilityResponse",
"short": "EligibilityResponse resource",
"definition": "This resource provides eligibility and plan details from the processing of an Eligibility resource.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "w5",
"map": "financial.support"
}
]
},
{
"id": "EligibilityResponse.identifier",
"path": "EligibilityResponse.identifier",
"short": "Business Identifier",
"definition": "The Response business identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "EligibilityResponse.status",
"path": "EligibilityResponse.status",
"short": "active | cancelled | draft | entered-in-error",
"definition": "The status of the resource instance.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "A code specifying the state of the resource instance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/eligibilityresponse-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "EligibilityResponse.request[x]",
"path": "EligibilityResponse.request[x]",
"short": "Claim reference",
"definition": "Original request resource reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/EligibilityRequest"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "EligibilityResponse.outcome",
"path": "EligibilityResponse.outcome",
"short": "complete | error | partial",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The outcome of the processing.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/remittance-outcome"
}
}
},
{
"id": "EligibilityResponse.disposition",
"path": "EligibilityResponse.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "EligibilityResponse.ruleset",
"path": "EligibilityResponse.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "The static and dynamic model to which contents conform, which may be business version or standard/version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ruleset"
}
},
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "EligibilityResponse.originalRuleset",
"path": "EligibilityResponse.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "The static and dynamic model to which contents conform, which may be business version or standard/version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ruleset"
}
}
},
{
"id": "EligibilityResponse.created",
"path": "EligibilityResponse.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "EligibilityResponse.organization[x]",
"path": "EligibilityResponse.organization[x]",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"id": "EligibilityResponse.requestProvider[x]",
"path": "EligibilityResponse.requestProvider[x]",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "EligibilityResponse.requestOrganization[x]",
"path": "EligibilityResponse.requestOrganization[x]",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "EligibilityResponse.inforce",
"path": "EligibilityResponse.inforce",
"short": "Coverage inforce",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "EligibilityResponse.contract",
"path": "EligibilityResponse.contract",
"short": "Contract details",
"definition": "The contract resource which may provide more detailed information.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Contract"
}
]
},
{
"id": "EligibilityResponse.form",
"path": "EligibilityResponse.form",
"short": "Printed Form Identifier",
"definition": "The form to be used for printing the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "required",
"description": "The forms codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/forms"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "G42"
}
]
},
{
"id": "EligibilityResponse.benefitBalance",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Benefits"
}
],
"path": "EligibilityResponse.benefitBalance",
"short": "Benefits by Category",
"definition": "Benefits and optionally current balances by Category.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.category",
"path": "EligibilityResponse.benefitBalance.category",
"short": "Benefit Category",
"definition": "Dental, Vision, Medical, Pharmacy, Rehab etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "Benefit categories such as: oral, medical, vision etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-category"
}
}
},
{
"id": "EligibilityResponse.benefitBalance.subCategory",
"path": "EligibilityResponse.benefitBalance.subCategory",
"short": "Benefit SubCategory",
"definition": "Dental: basic, major, ortho; Vision exam, glasses, contacts; etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "Benefit subcategories such as: oral-basic, major, glasses",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory"
}
}
},
{
"id": "EligibilityResponse.benefitBalance.name",
"path": "EligibilityResponse.benefitBalance.name",
"short": "Short name for the benefit",
"definition": "A short name or tag for the benefit, for example MED01, or DENT2.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.description",
"path": "EligibilityResponse.benefitBalance.description",
"short": "Description of the benefit",
"definition": "A richer description of the benefit, for example 'DENT2 covers 100% of basic, 50% of major but exclused Ortho, Implants and Costmetic services'.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.network",
"path": "EligibilityResponse.benefitBalance.network",
"short": "In or out of network",
"definition": "Network designation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "Code to classify in or out of network services",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-network"
}
}
},
{
"id": "EligibilityResponse.benefitBalance.unit",
"path": "EligibilityResponse.benefitBalance.unit",
"short": "Individual or family",
"definition": "Unit designation: individual or family.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "Unit covered/serviced - individual or family",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-unit"
}
}
},
{
"id": "EligibilityResponse.benefitBalance.term",
"path": "EligibilityResponse.benefitBalance.term",
"short": "Annual or lifetime",
"definition": "The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual vistis'.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "Coverage unit - annual, lifetime",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-term"
}
}
},
{
"id": "EligibilityResponse.benefitBalance.financial",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Benefit"
}
],
"path": "EligibilityResponse.benefitBalance.financial",
"short": "Benefit Summary",
"definition": "Benefits Used to date.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.financial.type",
"path": "EligibilityResponse.benefitBalance.financial.type",
"short": "Deductable, visits, benefit amount",
"definition": "Deductable, visits, benefit amount.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "Deductable, visits, co-pay, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-type"
}
}
},
{
"id": "EligibilityResponse.benefitBalance.financial.benefit[x]",
"path": "EligibilityResponse.benefitBalance.financial.benefit[x]",
"short": "Benefits allowed",
"definition": "Benefits allowed.",
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
},
{
"code": "string"
},
{
"code": "Money"
}
]
},
{
"id": "EligibilityResponse.benefitBalance.financial.benefitUsed[x]",
"path": "EligibilityResponse.benefitBalance.financial.benefitUsed[x]",
"short": "Benefits used",
"definition": "Benefits used.",
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
},
{
"code": "Money"
}
]
},
{
"id": "EligibilityResponse.error",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Errors"
}
],
"path": "EligibilityResponse.error",
"short": "Processing errors",
"definition": "Mutually exclusive with Services Provided (Item).",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "EligibilityResponse.error.code",
"path": "EligibilityResponse.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.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "required",
"description": "The error codes for adjudication processing.",
"valueSetReference": {
"reference": "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.
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change