2nd DSTU Draft For Comment
This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
Profile for claimresponse
{
"resourceType": "Profile",
"id": "ClaimResponse",
"meta": {
"lastUpdated": "2015-02-23T09:07:27.665+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/Profile/ClaimResponse",
"name": "ClaimResponse",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base Profile for ClaimResponse Resource",
"status": "draft",
"date": "2015-02-23T09:07:27+11:00",
"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"
}
],
"type": "ClaimResponse",
"snapshot": {
"element": [
{
"path": "ClaimResponse",
"short": "Remittance resource",
"definition": "This resource provides the adjudication details from the processing of a Claim resource.",
"synonym": [
"Remittance Advice"
],
"min": 1,
"max": "1"
},
{
"path": "ClaimResponse.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ClaimResponse.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ClaimResponse.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ClaimResponse.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource\n\nNot all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"isExtensible": false,
"conformance": "required",
"description": "A human language",
"referenceUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ClaimResponse.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.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ClaimResponse.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.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.identifier",
"short": "Response number",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ClaimResponse.request",
"short": "Id of resource triggering adjudication",
"definition": "Original request resource referrence.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/OralHealthClaim"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/PharmacyClaim"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/VisionClaim"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/ProfessionalClaim"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/InstitutionalClaim"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "ClaimResponse.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": {
"name": "Ruleset",
"isExtensible": true,
"conformance": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ClaimResponse.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": {
"name": "Ruleset",
"isExtensible": true,
"conformance": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ClaimResponse.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ClaimResponse.organization",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Organization"
}
]
},
{
"path": "ClaimResponse.requestProvider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "ClaimResponse.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Organization"
}
]
},
{
"path": "ClaimResponse.outcome",
"short": "complete | error",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RemittanceOutcome",
"isExtensible": false,
"conformance": "required",
"description": "The outcome of the processing.",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/RS-link"
}
}
},
{
"path": "ClaimResponse.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClaimResponse.payeeType",
"short": "Party to be paid any benefits payable",
"definition": "Party to be reimbursed: Subscriber, provider, other.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "PayeeType",
"isExtensible": true,
"conformance": "example",
"description": "A code for the party to be reimbursed.",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/payeetype"
}
}
},
{
"path": "ClaimResponse.item",
"short": "Line items",
"definition": "The first tier service adjudications for submitted services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.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. 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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.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.",
"synonym": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.item.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F07"
}
]
},
{
"path": "ClaimResponse.item.noteNumber",
"short": "List of note numbers which apply",
"definition": "A list of note references to the notes provided below.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.item.adjudication",
"short": "Adjudication details",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.adjudication.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.adjudication.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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.adjudication.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.",
"synonym": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.item.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"isExtensible": true,
"conformance": "preferred",
"description": "The adjudication codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.item.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.item.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.item.detail",
"short": "Detail line items",
"definition": "The second tier service adjudications for submitted services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.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.",
"synonym": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.item.detail.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F07"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication",
"short": "Detail adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.adjudication.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication.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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication.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.",
"synonym": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"isExtensible": true,
"conformance": "preferred",
"description": "The adjudication codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.item.detail.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.item.detail.subdetail",
"short": "Subdetail line items",
"definition": "The third tier service adjudications for submitted services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.subdetail.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.subdetail.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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.subdetail.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.",
"synonym": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.item.detail.subdetail.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F07"
}
]
},
{
"path": "ClaimResponse.item.detail.subdetail.adjudication",
"short": "Subdetail adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.subdetail.adjudication.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.subdetail.adjudication.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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.subdetail.adjudication.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.",
"synonym": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.item.detail.subdetail.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"isExtensible": true,
"conformance": "preferred",
"description": "The adjudication codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.item.detail.subdetail.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.item.detail.subdetail.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.additem",
"short": "Insurer added line items",
"definition": "The first tier service adjudications for payor added services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.additem.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.additem.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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.additem.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.",
"synonym": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.additem.sequenceLinkId",
"short": "Service instances",
"definition": "List of input service items which this service line is intended to replace.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.additem.service",
"short": "Group, Service or Product",
"definition": "A code to indicate the Professional Service or Product supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"isExtensible": true,
"conformance": "example",
"description": "Allowable service and product codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "ClaimResponse.additem.fee",
"short": "Professional fee or Product charge",
"definition": "The fee charged for the professional service or product..",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.additem.noteNumberLinkId",
"short": "List of note numbers which apply",
"definition": "A list of note references to the notes provided below.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.additem.adjudication",
"short": "Added items adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.additem.adjudication.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.additem.adjudication.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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.additem.adjudication.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.",
"synonym": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.additem.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"isExtensible": true,
"conformance": "preferred",
"description": "The adjudication codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.additem.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.additem.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.additem.detail",
"short": "Added items details",
"definition": "The second tier service adjudications for payor added services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.additem.detail.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.additem.detail.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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.additem.detail.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.",
"synonym": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.additem.detail.service",
"short": "Service or Product",
"definition": "A code to indicate the Professional Service or Product supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"isExtensible": true,
"conformance": "example",
"description": "Allowable service and product codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "ClaimResponse.additem.detail.fee",
"short": "Professional fee or Product charge",
"definition": "The fee charged for the professional service or product..",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.additem.detail.adjudication",
"short": "Added items detail adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.additem.detail.adjudication.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.additem.detail.adjudication.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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.additem.detail.adjudication.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.",
"synonym": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.additem.detail.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"isExtensible": true,
"conformance": "preferred",
"description": "The adjudication codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.additem.detail.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.additem.detail.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.error",
"short": "Processing errors",
"definition": "Mutually exclusive with Services Provided (Item).",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.error.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.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.",
"synonym": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.error.sequenceLinkId",
"short": "Item sequence number",
"definition": "The sequence number of the line item submitted which contains the error. This value is ommitted when the error is elsewhere.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.error.detailSequenceLinkId",
"short": "Detail sequence number",
"definition": "The sequence number of the addition within the line item submitted which contains the error. This value is ommitted when the error is not related to an Addition.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.error.subdetailSequenceLinkId",
"short": "Subdetail sequence number",
"definition": "The sequence number of the addition within the line item submitted which contains the error. This value is ommitted when the error is not related to an Addition.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.error.code",
"short": "Error code detailing processing issues",
"definition": "An error code,froma specified code system, which details why the claim could not be adjudicated.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AdjudicationError",
"isExtensible": true,
"conformance": "preferred",
"description": "The error codes for adjudication processing",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjudication-error"
}
}
},
{
"path": "ClaimResponse.totalCost",
"short": "Total Cost of service from the Claim",
"definition": "The total cost of the services reported.",
"requirements": "This is a check value that the receiver calculates and returns.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.unallocDeductable",
"short": "Unallocated deductable",
"definition": "The amount of deductable applied which was not allocated to any particular service line.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.totalBenefit",
"short": "Total benefit payable for the Claim",
"definition": "Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductable).",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.paymentAdjustment",
"short": "Payment adjustment for non-Claim issues",
"definition": "Adjustment to the payment of this transaction which is not related to adjudication of this transaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.paymentAdjustmentReason",
"short": "Reason for Payment adjustment",
"definition": "Reason for the payment adjustment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AdjustmentReason",
"isExtensible": true,
"conformance": "preferred",
"description": "Adjustment reason codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjustment-reason"
}
}
},
{
"path": "ClaimResponse.paymentDate",
"short": "Expected data of Payment",
"definition": "Estimated payment data.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"path": "ClaimResponse.paymentAmount",
"short": "Payment amount",
"definition": "Payable less any payment adjustment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.paymentRef",
"short": "Payment identifier",
"definition": "Payment identifer.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ClaimResponse.reserved",
"short": "Funds reserved status",
"definition": "Status of funds reservation (For provider, for Patient, None).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "FundsReserve",
"isExtensible": true,
"conformance": "example",
"description": "For whom funds are to be reserved: (Patient, Provider, None)",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/fundsreserve"
}
}
},
{
"path": "ClaimResponse.form",
"short": "Printed Form Identifier",
"definition": "The form to be used for printing the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Forms",
"isExtensible": true,
"conformance": "preferred",
"description": "The forms codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/forms"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "G42"
}
]
},
{
"path": "ClaimResponse.note",
"short": "Processing notes",
"definition": "Note text.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.note.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.note.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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.note.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.",
"synonym": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.note.number",
"short": "Note Number for this note",
"definition": "An integer associated with each note which may be referred to from each service line item.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.note.type",
"short": "display | print | printoper",
"definition": "The note purpose: Print/Display.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "NoteType",
"isExtensible": true,
"conformance": "preferred",
"description": "The presentation types of notes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/NT-link"
}
}
},
{
"path": "ClaimResponse.note.text",
"short": "Note explanitory text",
"definition": "The note text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "G32"
}
]
}
]
},
"differential": {
"element": [
{
"path": "ClaimResponse",
"short": "Remittance resource",
"definition": "This resource provides the adjudication details from the processing of a Claim resource.",
"synonym": [
"Remittance Advice"
],
"min": 1,
"max": "1"
},
{
"path": "ClaimResponse.identifier",
"short": "Response number",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ClaimResponse.request",
"short": "Id of resource triggering adjudication",
"definition": "Original request resource referrence.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/OralHealthClaim"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/PharmacyClaim"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/VisionClaim"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/ProfessionalClaim"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/InstitutionalClaim"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "ClaimResponse.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": {
"name": "Ruleset",
"isExtensible": true,
"conformance": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ClaimResponse.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": {
"name": "Ruleset",
"isExtensible": true,
"conformance": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ClaimResponse.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ClaimResponse.organization",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Organization"
}
]
},
{
"path": "ClaimResponse.requestProvider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "ClaimResponse.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Organization"
}
]
},
{
"path": "ClaimResponse.outcome",
"short": "complete | error",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RemittanceOutcome",
"isExtensible": false,
"conformance": "required",
"description": "The outcome of the processing.",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/RS-link"
}
}
},
{
"path": "ClaimResponse.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClaimResponse.payeeType",
"short": "Party to be paid any benefits payable",
"definition": "Party to be reimbursed: Subscriber, provider, other.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "PayeeType",
"isExtensible": true,
"conformance": "example",
"description": "A code for the party to be reimbursed.",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/payeetype"
}
}
},
{
"path": "ClaimResponse.item",
"short": "Line items",
"definition": "The first tier service adjudications for submitted services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F07"
}
]
},
{
"path": "ClaimResponse.item.noteNumber",
"short": "List of note numbers which apply",
"definition": "A list of note references to the notes provided below.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.item.adjudication",
"short": "Adjudication details",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"isExtensible": true,
"conformance": "preferred",
"description": "The adjudication codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.item.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.item.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.item.detail",
"short": "Detail line items",
"definition": "The second tier service adjudications for submitted services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F07"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication",
"short": "Detail adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"isExtensible": true,
"conformance": "preferred",
"description": "The adjudication codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.item.detail.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.item.detail.subdetail",
"short": "Subdetail line items",
"definition": "The third tier service adjudications for submitted services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.subdetail.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F07"
}
]
},
{
"path": "ClaimResponse.item.detail.subdetail.adjudication",
"short": "Subdetail adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.subdetail.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"isExtensible": true,
"conformance": "preferred",
"description": "The adjudication codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.item.detail.subdetail.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.item.detail.subdetail.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.additem",
"short": "Insurer added line items",
"definition": "The first tier service adjudications for payor added services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.additem.sequenceLinkId",
"short": "Service instances",
"definition": "List of input service items which this service line is intended to replace.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.additem.service",
"short": "Group, Service or Product",
"definition": "A code to indicate the Professional Service or Product supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"isExtensible": true,
"conformance": "example",
"description": "Allowable service and product codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "ClaimResponse.additem.fee",
"short": "Professional fee or Product charge",
"definition": "The fee charged for the professional service or product..",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.additem.noteNumberLinkId",
"short": "List of note numbers which apply",
"definition": "A list of note references to the notes provided below.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.additem.adjudication",
"short": "Added items adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.additem.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"isExtensible": true,
"conformance": "preferred",
"description": "The adjudication codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.additem.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.additem.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.additem.detail",
"short": "Added items details",
"definition": "The second tier service adjudications for payor added services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.additem.detail.service",
"short": "Service or Product",
"definition": "A code to indicate the Professional Service or Product supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"isExtensible": true,
"conformance": "example",
"description": "Allowable service and product codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "ClaimResponse.additem.detail.fee",
"short": "Professional fee or Product charge",
"definition": "The fee charged for the professional service or product..",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.additem.detail.adjudication",
"short": "Added items detail adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.additem.detail.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"isExtensible": true,
"conformance": "preferred",
"description": "The adjudication codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.additem.detail.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.additem.detail.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.error",
"short": "Processing errors",
"definition": "Mutually exclusive with Services Provided (Item).",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.error.sequenceLinkId",
"short": "Item sequence number",
"definition": "The sequence number of the line item submitted which contains the error. This value is ommitted when the error is elsewhere.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.error.detailSequenceLinkId",
"short": "Detail sequence number",
"definition": "The sequence number of the addition within the line item submitted which contains the error. This value is ommitted when the error is not related to an Addition.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.error.subdetailSequenceLinkId",
"short": "Subdetail sequence number",
"definition": "The sequence number of the addition within the line item submitted which contains the error. This value is ommitted when the error is not related to an Addition.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.error.code",
"short": "Error code detailing processing issues",
"definition": "An error code,froma specified code system, which details why the claim could not be adjudicated.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AdjudicationError",
"isExtensible": true,
"conformance": "preferred",
"description": "The error codes for adjudication processing",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjudication-error"
}
}
},
{
"path": "ClaimResponse.totalCost",
"short": "Total Cost of service from the Claim",
"definition": "The total cost of the services reported.",
"requirements": "This is a check value that the receiver calculates and returns.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.unallocDeductable",
"short": "Unallocated deductable",
"definition": "The amount of deductable applied which was not allocated to any particular service line.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.totalBenefit",
"short": "Total benefit payable for the Claim",
"definition": "Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductable).",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.paymentAdjustment",
"short": "Payment adjustment for non-Claim issues",
"definition": "Adjustment to the payment of this transaction which is not related to adjudication of this transaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.paymentAdjustmentReason",
"short": "Reason for Payment adjustment",
"definition": "Reason for the payment adjustment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AdjustmentReason",
"isExtensible": true,
"conformance": "preferred",
"description": "Adjustment reason codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/adjustment-reason"
}
}
},
{
"path": "ClaimResponse.paymentDate",
"short": "Expected data of Payment",
"definition": "Estimated payment data.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"path": "ClaimResponse.paymentAmount",
"short": "Payment amount",
"definition": "Payable less any payment adjustment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.paymentRef",
"short": "Payment identifier",
"definition": "Payment identifer.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ClaimResponse.reserved",
"short": "Funds reserved status",
"definition": "Status of funds reservation (For provider, for Patient, None).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "FundsReserve",
"isExtensible": true,
"conformance": "example",
"description": "For whom funds are to be reserved: (Patient, Provider, None)",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/fundsreserve"
}
}
},
{
"path": "ClaimResponse.form",
"short": "Printed Form Identifier",
"definition": "The form to be used for printing the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Forms",
"isExtensible": true,
"conformance": "preferred",
"description": "The forms codes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/forms"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "G42"
}
]
},
{
"path": "ClaimResponse.note",
"short": "Processing notes",
"definition": "Note text.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.note.number",
"short": "Note Number for this note",
"definition": "An integer associated with each note which may be referred to from each service line item.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.note.type",
"short": "display | print | printoper",
"definition": "The note purpose: Print/Display.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "NoteType",
"isExtensible": true,
"conformance": "preferred",
"description": "The presentation types of notes",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/NT-link"
}
}
},
{
"path": "ClaimResponse.note.text",
"short": "Note explanitory text",
"definition": "The note text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "G32"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU (v0.4.0-4167) generated on Mon, Feb 23, 2015 09:19+1100.
Links: What's a DSTU? |
Version History |
Compare to DSTU1 |
|
Propose a change