This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
(v4.0.1:
R4
-
Mixed
Normative
and
STU
3).
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
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
R4
R3
R2
| Financial Management Work Group | Maturity Level : N/A |
|
Compartments : Device , Encounter , Patient , Practitioner , RelatedPerson |
Raw JSON ( canonical form + also see JSON Format Specification )
StructureDefinition for claim
Financial
{
"resourceType": "StructureDefinition",
"id": "Claim",
"meta": {
"lastUpdated": "2019-10-24T11:53:00+11:00"
"resourceType" : "StructureDefinition",
"id" : "Claim",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fm"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/Claim",
"name": "Claim",
"status": "draft",
"date": "2019-10-24T11:53:00+11:00",
"publisher": "Health Level Seven International (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Claim Resource",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "Claim",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "Claim",
"path": "Claim",
"short": "Claim, Pre-determination or Pre-authorization",
"definition": "A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-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)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-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))]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Request"
},
{
"identity": "w5",
"map": "financial.billing"
}
]
},
{
"id": "Claim.id",
"path": "Claim.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "Claim.meta",
"path": "Claim.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": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "Claim.implicitRules",
"path": "Claim.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.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Financial.Billing"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fm"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Claim",
"version" : "4.0.1",
"name" : "Claim",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Financial Management)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fm/index.cfm"
}]
}],
"description" : "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.",
"purpose" : "The Claim resource is used by providers to exchange services and products rendered to patients or planned to be rendered with insurers for reimbuserment. It is also used by insurers to exchange claims information with statutory reporting and data analytics firms.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Claim",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Claim",
"path" : "Claim",
"short" : "Claim, Pre-determination or Pre-authorization",
"definition" : "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.",
"comment" : "The Claim resource fulfills three information request requirements: Claim - a request for adjudication for reimbursement for products and/or services provided; Preauthorization - a request to authorize the future provision of products and/or services including an anticipated adjudication; and, Predetermination - a request for a non-bind adjudication of possible future products and/or services.",
"alias" : ["Adjudication Request",
"Preauthorization Request",
"Predetermination Request"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.language",
"path": "Claim.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"id": "Claim.text",
"path": "Claim.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.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"id": "Claim.contained",
"path": "Claim.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"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"
}
]
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"id": "Claim.extension",
"path": "Claim.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"id": "Claim.modifierExtension",
"path": "Claim.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"id": "Claim.identifier",
"path": "Claim.identifier",
"short": "Claim number",
"definition": "The business identifier for the instance: claim number, pre-determination or pre-authorization number.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.identifier"
},
{
"identity": "w5",
"map": "id"
}
]
"identity" : "workflow",
"map" : "Request"
}]
},
{
"id" : "Claim.id",
"path" : "Claim.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.status",
"path": "Claim.status",
"short": "active | cancelled | draft | entered-in-error",
"definition": "The status of the resource instance.",
"comment": "This element is labeled as a modifier because the status contains the code entered-in-error that marks the claim as not currently valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ClaimStatus"
}
],
"strength": "required",
"description": "A code specifying the state of the resource instance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/fm-status"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.status"
},
{
"identity": "w5",
"map": "status"
}
]
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Claim.meta",
"path" : "Claim.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.type",
"path": "Claim.type",
"short": "Type or discipline",
"definition": "The category of claim, eg, oral, pharmacy, vision, insitutional, professional.",
"comment": "Affects which fields and value sets are used.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ClaimType"
}
],
"strength": "required",
"description": "The type or discipline-style of the claim",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-type"
}
},
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Claim.implicitRules",
"path" : "Claim.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.subType",
"path": "Claim.subType",
"short": "Finer grained claim type information",
"definition": "A finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType.",
"comment": "This may contain the local bill type codes such as the US UB-04 bill type code.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ClaimSubType"
}
],
"strength": "example",
"description": "A more granular claim typecode",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-subtype"
}
},
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Claim.language",
"path" : "Claim.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.use",
"path": "Claim.use",
"short": "complete | proposed | exploratory | other",
"definition": "Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Use"
}
],
"strength": "required",
"description": "Complete, proposed, exploratory, other",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-use"
}
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Claim.patient",
"path": "Claim.patient",
"short": "The subject of the Products and Services",
"definition": "Patient Resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.subject"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "Claim.billablePeriod",
"path": "Claim.billablePeriod",
"short": "Period for charge submission",
"definition": "The billable period for which charges are being submitted.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "Claim.created",
"path": "Claim.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": "workflow",
"map": "Request.authoredOn"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "Claim.enterer",
"path": "Claim.enterer",
"short": "Author",
"definition": "Person who created the invoice/claim/pre-determination or pre-authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.author"
}
]
},
{
"id": "Claim.insurer",
"path": "Claim.insurer",
"short": "Target",
"definition": "The Insurer who is target of the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.performer"
}
]
},
{
"id": "Claim.provider",
"path": "Claim.provider",
"short": "Responsible provider",
"definition": "The provider which is responsible for the bill, claim pre-determination, pre-authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.requester.agent"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "Claim.organization",
"path": "Claim.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the bill, claim pre-determination, pre-authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.requester.onBehalfOf"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "Claim.priority",
"path": "Claim.priority",
"short": "Desired processing priority",
"definition": "Immediate (STAT), best effort (NORMAL), deferred (DEFER).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ProcessPriority"
}
],
"strength": "example",
"description": "The timeliness with which processing is required: STAT, normal, Deferred",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/process-priority"
}
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
"mapping": [
{
"identity": "workflow",
"map": "Request.priority"
}
]
},
{
"id": "Claim.fundsReserve",
"path": "Claim.fundsReserve",
"short": "Funds requested to be reserved",
"definition": "In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FundsReserve"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "example",
"description": "For whom funds are to be reserved: (Patient, Provider, None).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/fundsreserve"
}
}
},
{
"id": "Claim.related",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "RelatedClaim"
}
],
"path": "Claim.related",
"short": "Related Claims which may be revelant to processing this claimn",
"definition": "Other claims which are related to this claim such as prior claim versions or for related services.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Claim.text",
"path" : "Claim.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.related.id",
"path": "Claim.related.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Claim.contained",
"path" : "Claim.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.related.extension",
"path": "Claim.related.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.extension",
"path" : "Claim.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.related.modifierExtension",
"path": "Claim.related.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.related.claim",
"path": "Claim.related.claim",
"short": "Reference to the related claim",
"definition": "Other claims which are related to this claim such as prior claim versions or for related services.",
"comment": "Do we need a relationship code?",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Claim"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.replaces"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.modifierExtension",
"path" : "Claim.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.related.relationship",
"path": "Claim.related.relationship",
"short": "How the reference claim is related",
"definition": "For example prior or umbrella.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedClaimRelationship"
}
],
"strength": "example",
"description": "Relationship of this claim to a related Claim",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/related-claim-relationship"
}
}
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.related.reference",
"path": "Claim.related.reference",
"short": "Related file or case reference",
"definition": "An alternate organizational reference to the case or file to which this particular claim pertains - eg Property/Casualy insurer claim # or Workers Compensation case # .",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.identifier",
"path" : "Claim.identifier",
"short" : "Business Identifier for claim",
"definition" : "A unique identifier assigned to this claim.",
"requirements" : "Allows claims to be distinguished and referenced.",
"alias" : ["Claim Number"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.identifier",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.prescription",
"path": "Claim.prescription",
"short": "Prescription authorizing services or products",
"definition": "Prescription to support the dispensing of Pharmacy or Vision products.",
"comment": "Should we create a group to hold multiple prescriptions and add a sequence number and on the line items a link to the sequence.",
"requirements": "For type=Pharmacy and Vision only.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/VisionPrescription"
}
]
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"id": "Claim.originalPrescription",
"path": "Claim.originalPrescription",
"short": "Original prescription if superceded by fulfiller",
"definition": "Original prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.",
"comment": "as above.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest"
}
]
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Claim.status",
"path" : "Claim.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.status",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.payee",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Payee"
}
],
"path": "Claim.payee",
"short": "Party to be paid any benefits payable",
"definition": "The party to be reimbursed for the services.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.0.1"
},
{
"id": "Claim.payee.id",
"path": "Claim.payee.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"id": "Claim.payee.extension",
"path": "Claim.payee.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "Claim.type",
"path" : "Claim.type",
"short" : "Category or discipline",
"definition" : "The category of claim, e.g. oral, pharmacy, vision, institutional, professional.",
"comment" : "The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements.",
"requirements" : "Claim type determine the general sets of business rules applied for information requirements and adjudication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.type",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.payee.modifierExtension",
"path": "Claim.payee.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimType"
}],
"strength" : "extensible",
"description" : "The type or discipline-style of the claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-type"
},
{
"id": "Claim.payee.type",
"path": "Claim.payee.type",
"short": "Type of party: Subscriber, Provider, other",
"definition": "Type of Party to be reimbursed: Subscriber, provider, other.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PayeeType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "example",
"description": "A code for the party to be reimbursed.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/payeetype"
}
}
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Claim.subType",
"path" : "Claim.subType",
"short" : "More granular claim type",
"definition" : "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.",
"comment" : "This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.",
"requirements" : "Some jurisdictions need a finer grained claim type for routing and adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.subType",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.payee.resourceType",
"path": "Claim.payee.resourceType",
"short": "organization | patient | practitioner | relatedperson",
"definition": "organization | patient | practitioner | relatedperson.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ClaimPayeeResourceType"
}
],
"strength": "example",
"description": "The type of Claim payee Resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-payee-resource-type"
}
}
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimSubType"
}],
"strength" : "example",
"description" : "A more granular claim typecode.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-subtype"
},
{
"id": "Claim.payee.party",
"path": "Claim.payee.party",
"short": "Party to receive the payable",
"definition": "Party to be reimbursed: Subscriber, provider, other.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Claim.use",
"path" : "Claim.use",
"short" : "claim | preauthorization | predetermination",
"definition" : "A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.",
"requirements" : "This element is required to understand the nature of the request for adjudication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.use",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.referral",
"path": "Claim.referral",
"short": "Treatment Referral",
"definition": "The referral resource which lists the date, practitioner, reason and other supporting information.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.cause"
}
]
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Use"
}],
"strength" : "required",
"description" : "The purpose of the Claim: predetermination, preauthorization, claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-use|4.0.1"
},
{
"id": "Claim.facility",
"path": "Claim.facility",
"short": "Servicing Facility",
"definition": "Facility where the services were provided.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "w5",
"map": "where"
}
]
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Claim.patient",
"path" : "Claim.patient",
"short" : "The recipient of the products and services",
"definition" : "The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.",
"requirements" : "The patient must be supplied to the insurer so that confirmation of coverage and service history may be considered as part of the authorization and/or adjudiction.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.patient",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.careTeam",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "CareTeam"
}
],
"path": "Claim.careTeam",
"short": "Members of the care team",
"definition": "The members of the team who provided the overall service as well as their role and whether responsible and qualifications.",
"requirements": "Role and Responsible may not be required when there is only a single provider listed.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"id": "Claim.careTeam.id",
"path": "Claim.careTeam.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"id": "Claim.careTeam.extension",
"path": "Claim.careTeam.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Claim.billablePeriod",
"path" : "Claim.billablePeriod",
"short" : "Relevant time frame for the claim",
"definition" : "The period for which charges are being submitted.",
"comment" : "Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and predeterminations. Typically line item dates of service should fall within the billing period if one is specified.",
"requirements" : "A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.billablePeriod",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.careTeam.modifierExtension",
"path": "Claim.careTeam.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Claim.created",
"path" : "Claim.created",
"short" : "Resource creation date",
"definition" : "The date this resource was created.",
"comment" : "This field is independent of the date of creation of the resource as it may reflect the creation date of a source document prior to digitization. Typically for claims all services must be completed as of this date.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.created",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.careTeam.sequence",
"path": "Claim.careTeam.sequence",
"short": "Number to covey order of careTeam",
"definition": "Sequence of the careTeam which serves to order and provide a link.",
"requirements": "Required to maintain order of the careTeam.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"id": "Claim.careTeam.provider",
"path": "Claim.careTeam.provider",
"short": "Provider individual or organization",
"definition": "Member of the team who provided the overall service.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.actor"
}
]
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "Claim.enterer",
"path" : "Claim.enterer",
"short" : "Author of the claim",
"definition" : "Individual who created the claim, predetermination or preauthorization.",
"requirements" : "Some jurisdictions require the contact information for personnel completing claims.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.enterer",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.careTeam.responsible",
"path": "Claim.careTeam.responsible",
"short": "Billing provider",
"definition": "The party who is billing and responsible for the claimed good or service rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
}]
},
{
"id" : "Claim.insurer",
"path" : "Claim.insurer",
"short" : "Target",
"definition" : "The Insurer who is target of the request.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.insurer",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.careTeam.role",
"path": "Claim.careTeam.role",
"short": "Role on the team",
"definition": "The lead, assisting or supervising practitioner and their discipline if a multidisiplinary team.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CareTeamRole"
}
],
"strength": "example",
"description": "The role codes for the care team members.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-careteamrole"
}
}
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
}]
},
{
"id" : "Claim.provider",
"path" : "Claim.provider",
"short" : "Party responsible for the claim",
"definition" : "The provider which is responsible for the claim, predetermination or preauthorization.",
"comment" : "Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.provider",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.careTeam.qualification",
"path": "Claim.careTeam.qualification",
"short": "Type, classification or Specialization",
"definition": "The qualification which is applicable for this service.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ProviderQualification"
}
],
"strength": "example",
"description": "Provider professional qualifications",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/provider-qualification"
}
}
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"id": "Claim.information",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "SpecialCondition"
}
],
"path": "Claim.information",
"short": "Exceptions, special considerations, the condition, situation, prior or concurrent issues",
"definition": "Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are mutiple jurisdiction specific valuesets which are required.",
"requirements": "Typically these information codes are required to support the services rendered or the adjudication of the services rendered.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.supportingInfo"
}
]
"identity" : "w5",
"map" : "FiveWs.source"
}]
},
{
"id" : "Claim.priority",
"path" : "Claim.priority",
"short" : "Desired processing ugency",
"definition" : "The provider-required urgency of processing the request. Typical values include: stat, routine deferred.",
"comment" : "If a claim processor is unable to complete the processing as per the priority then they should generate and error and not process the request.",
"requirements" : "The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.priority",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.information.id",
"path": "Claim.information.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcessPriority"
}],
"strength" : "example",
"description" : "The timeliness with which processing is required: stat, normal, deferred.",
"valueSet" : "http://hl7.org/fhir/ValueSet/process-priority"
},
{
"id": "Claim.information.extension",
"path": "Claim.information.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
}]
},
{
"id" : "Claim.fundsReserve",
"path" : "Claim.fundsReserve",
"short" : "For whom to reserve funds",
"definition" : "A code to indicate whether and for whom funds are to be reserved for future claims.",
"comment" : "This field is only used for preauthorizations.",
"requirements" : "In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.",
"alias" : ["Fund pre-allocation"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.fundsReserve",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.information.modifierExtension",
"path": "Claim.information.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FundsReserve"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "For whom funds are to be reserved: (Patient, Provider, None).",
"valueSet" : "http://hl7.org/fhir/ValueSet/fundsreserve"
}
},
{
"id" : "Claim.related",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "RelatedClaim"
}],
"path" : "Claim.related",
"short" : "Prior or corollary claims",
"definition" : "Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.",
"comment" : "For example, for the original treatment and follow-up exams.",
"requirements" : "For workplace or other accidents it is common to relate separate claims arising from the same event.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.related",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.information.sequence",
"path": "Claim.information.sequence",
"short": "Information instance identifier",
"definition": "Sequence of the information element which serves to provide a link.",
"requirements": "To provide a reference link.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.related.id",
"path" : "Claim.related.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.information.category",
"path": "Claim.information.category",
"short": "General class of information",
"definition": "The general class of the information supplied: information; exception; accident, employment; onset, etc.",
"comment": "This may contain the local bill type codes such as the US UB-04 bill type code.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "InformationCategory"
}
],
"strength": "example",
"description": "The valuset used for additional information category codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-informationcategory"
}
}
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.related.extension",
"path" : "Claim.related.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.information.code",
"path": "Claim.information.code",
"short": "Type of information",
"definition": "System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought which may influence the adjudication.",
"comment": "This may contain the local bill type codes such as the US UB-04 bill type code.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "InformationCode"
}
],
"strength": "example",
"description": "The valuset used for additional information codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-exception"
}
}
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.information.timing[x]",
"path": "Claim.information.timing[x]",
"short": "When it occurred",
"definition": "The date when or period to which this information refers.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
},
{
"code": "Period"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.related.modifierExtension",
"path" : "Claim.related.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.information.value[x]",
"path": "Claim.information.value[x]",
"short": "Additional Data or supporting information",
"definition": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
},
{
"code": "Quantity"
},
{
"code": "Attachment"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.information.reason",
"path": "Claim.information.reason",
"short": "Reason associated with the information",
"definition": "For example, provides the reason for: the additional stay, or missing tooth or any other situation where a reason code is required in addition to the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MissingReason"
}
],
"strength": "example",
"description": "Reason codes for the missing teeth",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/missing-tooth-reason"
}
}
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.related.claim",
"path" : "Claim.related.claim",
"short" : "Reference to the related claim",
"definition" : "Reference to a related claim.",
"requirements" : "For workplace or other accidents it is common to relate separate claims arising from the same event.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.related.claim",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.diagnosis",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Diagnosis"
}
],
"path": "Claim.diagnosis",
"short": "List of Diagnosis",
"definition": "List of patient diagnosis for which care is sought.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.reasonReference"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Claim"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
}]
},
{
"id" : "Claim.related.relationship",
"path" : "Claim.related.relationship",
"short" : "How the reference claim is related",
"definition" : "A code to convey how the claims are related.",
"comment" : "For example, prior claim or umbrella.",
"requirements" : "Some insurers need a declaration of the type of relationship.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.related.relationship",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.diagnosis.id",
"path": "Claim.diagnosis.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RelatedClaimRelationship"
}],
"strength" : "example",
"description" : "Relationship of this claim to a related Claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/related-claim-relationship"
}
},
{
"id" : "Claim.related.reference",
"path" : "Claim.related.reference",
"short" : "File or case reference",
"definition" : "An alternate organizational reference to the case or file to which this particular claim pertains.",
"comment" : "For example, Property/Casualty insurer claim # or Workers Compensation case # .",
"requirements" : "In cases where an event-triggered claim is being submitted to an insurer which requires a reference number to be specified on all exchanges.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.related.reference",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.diagnosis.extension",
"path": "Claim.diagnosis.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.prescription",
"path" : "Claim.prescription",
"short" : "Prescription authorizing services and products",
"definition" : "Prescription to support the dispensing of pharmacy, device or vision products.",
"requirements" : "Required to authorize the dispensing of controlled substances and devices.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.prescription",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.diagnosis.modifierExtension",
"path": "Claim.diagnosis.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/VisionPrescription"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.originalPrescription",
"path" : "Claim.originalPrescription",
"short" : "Original prescription if superseded by fulfiller",
"definition" : "Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.",
"comment" : "For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefore issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.",
"requirements" : "Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.originalPrescription",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.diagnosis.sequence",
"path": "Claim.diagnosis.sequence",
"short": "Number to covey order of diagnosis",
"definition": "Sequence of diagnosis which serves to provide a link.",
"requirements": "Required to allow line items to reference the diagnoses.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/VisionPrescription"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.payee",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Payee"
}],
"path" : "Claim.payee",
"short" : "Recipient of benefits payable",
"definition" : "The party to be reimbursed for cost of the products and services according to the terms of the policy.",
"comment" : "Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and choose to pay the subscriber instead.",
"requirements" : "The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.payee",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.diagnosis.diagnosis[x]",
"path": "Claim.diagnosis.diagnosis[x]",
"short": "Patient's diagnosis",
"definition": "The diagnosis.",
"requirements": "Required to adjudicate services rendered to condition presented.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ICD10"
}
],
"strength": "example",
"description": "ICD10 Diagnostic codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/icd-10"
}
}
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.payee.id",
"path" : "Claim.payee.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.diagnosis.type",
"path": "Claim.diagnosis.type",
"short": "Timing or nature of the diagnosis",
"definition": "The type of the Diagnosis, for example: admitting, primary, secondary, discharge.",
"comment": "Diagnosis are presented in list order to their expected importance: primary, secondary, etc.",
"requirements": "May be required to adjudicate services rendered.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DiagnosisType"
}
],
"strength": "example",
"description": "The type of the diagnosis: admitting, principal, discharge",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-diagnosistype"
}
}
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.payee.extension",
"path" : "Claim.payee.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.diagnosis.packageCode",
"path": "Claim.diagnosis.packageCode",
"short": "Package billing code",
"definition": "The package billing code, for example DRG, based on the assigned grouping code system.",
"requirements": "May be required to adjudicate services rendered to the mandated grouping system.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DiagnosisRelatedGroup"
}
],
"strength": "example",
"description": "The DRG codes associated with the diagnosis",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup"
}
}
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.procedure",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Procedure"
}
],
"path": "Claim.procedure",
"short": "Procedures performed",
"definition": "Ordered list of patient procedures performed to support the adjudication.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.payee.modifierExtension",
"path" : "Claim.payee.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.procedure.id",
"path": "Claim.procedure.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.procedure.extension",
"path": "Claim.procedure.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.payee.type",
"path" : "Claim.payee.type",
"short" : "Category of recipient",
"definition" : "Type of Party to be reimbursed: subscriber, provider, other.",
"requirements" : "Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.payee.type",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.procedure.modifierExtension",
"path": "Claim.procedure.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PayeeType"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "A code for the party to be reimbursed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/payeetype"
}
},
{
"id" : "Claim.payee.party",
"path" : "Claim.payee.party",
"short" : "Recipient reference",
"definition" : "Reference to the individual or organization to whom any payment will be made.",
"comment" : "Not required if the payee is 'subscriber' or 'provider'.",
"requirements" : "Need to provide demographics if the payee is not 'subscriber' nor 'provider'.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.payee.party",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.procedure.sequence",
"path": "Claim.procedure.sequence",
"short": "Procedure sequence for reference",
"definition": "Sequence of procedures which serves to order and provide a link.",
"requirements": "Required to maintain order of the procudures.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.referral",
"path" : "Claim.referral",
"short" : "Treatment referral",
"definition" : "A reference to a referral resource.",
"comment" : "The referral resource which lists the date, practitioner, reason and other supporting information.",
"requirements" : "Some insurers require proof of referral to pay for services or to pay specialist rates for services.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.referral",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.procedure.date",
"path": "Claim.procedure.date",
"short": "When the procedure was performed",
"definition": "Date and optionally time the procedure was performed .",
"comment": "SB DateTime??",
"requirements": "Required to adjudicate services rendered.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.cause"
}]
},
{
"id" : "Claim.facility",
"path" : "Claim.facility",
"short" : "Servicing facility",
"definition" : "Facility where the services were provided.",
"requirements" : "Insurance adjudication can be dependant on where services were delivered.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.facility",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.procedure.procedure[x]",
"path": "Claim.procedure.procedure[x]",
"short": "Patient's list of procedures performed",
"definition": "The procedure code.",
"requirements": "Required to adjudicate services rendered.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ICD10_Procedures"
}
],
"strength": "example",
"description": "ICD10 Procedure codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/icd-10-procedures"
}
}
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
}]
},
{
"id" : "Claim.careTeam",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "CareTeam"
}],
"path" : "Claim.careTeam",
"short" : "Members of the care team",
"definition" : "The members of the team who provided the products and services.",
"requirements" : "Common to identify the responsible and supporting practitioners.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.careTeam",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.insurance",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Insurance"
}
],
"path": "Claim.insurance",
"short": "Insurance or medical plan",
"definition": "Financial instrument by which payment information for health care.",
"requirements": "Health care programs and insurers are significant payors of health service costs.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "Coverage"
}
]
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.careTeam.id",
"path" : "Claim.careTeam.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.insurance.id",
"path": "Claim.insurance.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.careTeam.extension",
"path" : "Claim.careTeam.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.insurance.extension",
"path": "Claim.insurance.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.insurance.modifierExtension",
"path": "Claim.insurance.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.careTeam.modifierExtension",
"path" : "Claim.careTeam.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.insurance.sequence",
"path": "Claim.insurance.sequence",
"short": "Service instance identifier",
"definition": "Sequence of coverage which serves to provide a link and convey coordination of benefit order.",
"requirements": "To maintain order of the coverages.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.insurance.focal",
"path": "Claim.insurance.focal",
"short": "Is the focal Coverage",
"definition": "A flag to indicate that this Coverage is the focus for adjudication. The Coverage against which the claim is to be adjudicated.",
"requirements": "To identify which coverage is being adjudicated.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.careTeam.sequence",
"path" : "Claim.careTeam.sequence",
"short" : "Order of care team",
"definition" : "A number to uniquely identify care team entries.",
"requirements" : "Necessary to maintain the order of the care team and provide a mechanism to link individuals to claim details.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.careTeam.sequence",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.insurance.coverage",
"path": "Claim.insurance.coverage",
"short": "Insurance information",
"definition": "Reference to the program or plan identification, underwriter or payor.",
"requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Coverage"
}
]
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.careTeam.provider",
"path" : "Claim.careTeam.provider",
"short" : "Practitioner or organization",
"definition" : "Member of the team who provided the product or service.",
"requirements" : "Often a regulatory requirement to specify the responsible provider.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.careTeam.provider",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.insurance.businessArrangement",
"path": "Claim.insurance.businessArrangement",
"short": "Business agreement",
"definition": "The contract number of a business agreement which describes the terms and conditions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "Claim.careTeam.responsible",
"path" : "Claim.careTeam.responsible",
"short" : "Indicator of the lead practitioner",
"definition" : "The party who is billing and/or responsible for the claimed products or services.",
"comment" : "Responsible might not be required when there is only a single provider listed.",
"requirements" : "When multiple parties are present it is required to distinguish the lead or responsible individual.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.careTeam.responsible",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.insurance.preAuthRef",
"path": "Claim.insurance.preAuthRef",
"short": "Pre-Authorization/Determination Reference",
"definition": "A list of references from the Insurer to which these services pertain.",
"requirements": "To provide any pre=determination or prior authorization reference.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.careTeam.role",
"path" : "Claim.careTeam.role",
"short" : "Function within the team",
"definition" : "The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.",
"comment" : "Role might not be required when there is only a single provider listed.",
"requirements" : "When multiple parties are present it is required to distinguish the roles performed by each member.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.careTeam.role",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.insurance.claimResponse",
"path": "Claim.insurance.claimResponse",
"short": "Adjudication results",
"definition": "The Coverages adjudication details.",
"requirements": "Used by downstream payers to determine what balance remains and the net payable.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ClaimResponse"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamRole"
}],
"strength" : "example",
"description" : "The role codes for the care team members.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-careteamrole"
}
},
{
"id" : "Claim.careTeam.qualification",
"path" : "Claim.careTeam.qualification",
"short" : "Practitioner credential or specialization",
"definition" : "The qualification of the practitioner which is applicable for this service.",
"requirements" : "Need to specify which qualification a provider is delivering the product or service under.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.careTeam.qualification",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.accident",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Accident"
}
],
"path": "Claim.accident",
"short": "Details about an accident",
"definition": "An accident which resulted in the need for healthcare services.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProviderQualification"
}],
"strength" : "example",
"description" : "Provider professional qualifications.",
"valueSet" : "http://hl7.org/fhir/ValueSet/provider-qualification"
}
},
{
"id" : "Claim.supportingInfo",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SupportingInformation"
}],
"path" : "Claim.supportingInfo",
"short" : "Supporting information",
"definition" : "Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.",
"comment" : "Often there are multiple jurisdiction specific valuesets which are required.",
"requirements" : "Typically these information codes are required to support the services rendered or the adjudication of the services rendered.",
"alias" : ["Attachments\nException Codes\nOccurrence Codes\nValue codes"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.supportingInfo",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.accident.id",
"path": "Claim.accident.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
}]
},
{
"id" : "Claim.supportingInfo.id",
"path" : "Claim.supportingInfo.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.accident.extension",
"path": "Claim.accident.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.supportingInfo.extension",
"path" : "Claim.supportingInfo.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.accident.modifierExtension",
"path": "Claim.accident.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.accident.date",
"path": "Claim.accident.date",
"short": "When the accident occurred\nsee information codes\nsee information codes",
"definition": "Date of an accident which these services are addressing.",
"requirements": "Coverage may be dependant on accidents.",
"min": 1,
"max": "1",
"type": [
{
"code": "date"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.supportingInfo.modifierExtension",
"path" : "Claim.supportingInfo.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.accident.type",
"path": "Claim.accident.type",
"short": "The nature of the accident",
"definition": "Type of accident: work, auto, etc.",
"requirements": "Coverage may be dependant on the type of accident.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AccidentType"
}
],
"strength": "required",
"description": "Type of accident: work place, auto, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ActIncidentCode"
}
}
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.accident.location[x]",
"path": "Claim.accident.location[x]",
"short": "Accident Place",
"definition": "Accident Place.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.supportingInfo.sequence",
"path" : "Claim.supportingInfo.sequence",
"short" : "Information instance identifier",
"definition" : "A number to uniquely identify supporting information entries.",
"requirements" : "Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.supportingInfo.sequence",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.employmentImpacted",
"path": "Claim.employmentImpacted",
"short": "Period unable to work",
"definition": "The start and optional end dates of when the patient was precluded from working due to the treatable condition(s).",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.supportingInfo.category",
"path" : "Claim.supportingInfo.category",
"short" : "Classification of the supplied information",
"definition" : "The general class of the information supplied: information; exception; accident, employment; onset, etc.",
"comment" : "This may contain a category for the local bill type codes.",
"requirements" : "Required to group or associate information items with common characteristics. For example: admission information or prior treatments.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.supportingInfo.category",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.hospitalization",
"path": "Claim.hospitalization",
"short": "Period in hospital",
"definition": "The start and optional end dates of when the patient was confined to a treatment center.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "InformationCategory"
}],
"strength" : "example",
"description" : "The valuset used for additional information category codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-informationcategory"
}
},
{
"id" : "Claim.supportingInfo.code",
"path" : "Claim.supportingInfo.code",
"short" : "Type of information",
"definition" : "System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.",
"requirements" : "Required to identify the kind of additional information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.supportingInfo.code",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Item"
}
],
"path": "Claim.item",
"short": "Goods and Services",
"definition": "First tier of goods and services.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "InformationCode"
}],
"strength" : "example",
"description" : "The valuset used for additional information codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-exception"
}
},
{
"id" : "Claim.supportingInfo.timing[x]",
"path" : "Claim.supportingInfo.timing[x]",
"short" : "When it occurred",
"definition" : "The date when or period to which this information refers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.supportingInfo.timing[x]",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.id",
"path": "Claim.item.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "date"
},
{
"id": "Claim.item.extension",
"path": "Claim.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.supportingInfo.value[x]",
"path" : "Claim.supportingInfo.value[x]",
"short" : "Data to be provided",
"definition" : "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.",
"comment" : "Could be used to provide references to other resources, document. For example could contain a PDF in an Attachment of the Police Report for an Accident.",
"requirements" : "To convey the data content to be provided when the information is more than a simple code or period.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.supportingInfo.value[x]",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.modifierExtension",
"path": "Claim.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"type" : [{
"code" : "boolean"
},
{
"id": "Claim.item.sequence",
"path": "Claim.item.sequence",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"code" : "string"
},
{
"id": "Claim.item.careTeamLinkId",
"path": "Claim.item.careTeamLinkId",
"short": "Applicable careTeam members",
"definition": "CareTeam applicable for this service or product line.",
"min": 0,
"max": "*",
"type": [
{
"code": "positiveInt"
}
]
"code" : "Quantity"
},
{
"id": "Claim.item.diagnosisLinkId",
"path": "Claim.item.diagnosisLinkId",
"short": "Applicable diagnoses",
"definition": "Diagnosis applicable for this service or product line.",
"min": 0,
"max": "*",
"type": [
{
"code": "positiveInt"
}
]
"code" : "Attachment"
},
{
"id": "Claim.item.procedureLinkId",
"path": "Claim.item.procedureLinkId",
"short": "Applicable procedures",
"definition": "Procedures applicable for this service or product line.",
"min": 0,
"max": "*",
"type": [
{
"code": "positiveInt"
}
]
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.supportingInfo.reason",
"path" : "Claim.supportingInfo.reason",
"short" : "Explanation for the information",
"definition" : "Provides the reason in the situation where a reason code is required in addition to the content.",
"comment" : "For example: the reason for the additional stay, or why a tooth is missing.",
"requirements" : "Needed when the supporting information has both a date and amount/value and requires explanation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.supportingInfo.reason",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.informationLinkId",
"path": "Claim.item.informationLinkId",
"short": "Applicable exception and supporting information",
"definition": "Exceptions, special conditions and supporting information pplicable for this service or product line.",
"min": 0,
"max": "*",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MissingReason"
}],
"strength" : "example",
"description" : "Reason codes for the missing teeth.",
"valueSet" : "http://hl7.org/fhir/ValueSet/missing-tooth-reason"
}
},
{
"id" : "Claim.diagnosis",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Diagnosis"
}],
"path" : "Claim.diagnosis",
"short" : "Pertinent diagnosis information",
"definition" : "Information about diagnoses relevant to the claim items.",
"requirements" : "Required for the adjudication by provided context for the services and product listed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.diagnosis",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.revenue",
"path": "Claim.item.revenue",
"short": "Revenue or cost center code",
"definition": "The type of reveneu or cost center providing the product and/or service.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RevenueCenter"
}
],
"strength": "example",
"description": "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
}
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
}]
},
{
"id" : "Claim.diagnosis.id",
"path" : "Claim.diagnosis.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.category",
"path": "Claim.item.category",
"short": "Type of service or product",
"definition": "Health Care Service Type Codes to identify the classification of service or benefits.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BenefitSubCategory"
}
],
"strength": "example",
"description": "Benefit subcategories such as: oral-basic, major, glasses",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory"
}
}
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.diagnosis.extension",
"path" : "Claim.diagnosis.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.service",
"path": "Claim.item.service",
"short": "Billing Code",
"definition": "If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,RXNorm,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceProduct"
}
],
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-uscls"
}
}
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.item.modifier",
"path": "Claim.item.modifier",
"short": "Service/Product billing modifiers",
"definition": "Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Modifiers"
}
],
"strength": "example",
"description": "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
}
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.diagnosis.modifierExtension",
"path" : "Claim.diagnosis.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.programCode",
"path": "Claim.item.programCode",
"short": "Program specific reason for item inclusion",
"definition": "For programs which require reason codes for the inclusion or covering of this billed item under the program or sub-program.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ProgramCode"
}
],
"strength": "example",
"description": "Program specific reason codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-program-code"
}
}
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.item.serviced[x]",
"path": "Claim.item.serviced[x]",
"short": "Date or dates of Service",
"definition": "The date or dates when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
},
{
"code": "Period"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.done"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.diagnosis.sequence",
"path" : "Claim.diagnosis.sequence",
"short" : "Diagnosis instance identifier",
"definition" : "A number to uniquely identify diagnosis entries.",
"comment" : "Diagnosis are presented in list order to their expected importance: primary, secondary, etc.",
"requirements" : "Necessary to maintain the order of the diagnosis items and provide a mechanism to link to claim details.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.diagnosis.sequence",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.item.location[x]",
"path": "Claim.item.location[x]",
"short": "Place of service",
"definition": "Where the service was provided.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Address"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServicePlace"
}
],
"strength": "example",
"description": "Place of service: pharmacy,school, prison, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-place"
}
},
"mapping": [
{
"identity": "w5",
"map": "where"
}
]
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.diagnosis.diagnosis[x]",
"path" : "Claim.diagnosis.diagnosis[x]",
"short" : "Nature of illness or problem",
"definition" : "The nature of illness or problem in a coded form or as a reference to an external defined Condition.",
"requirements" : "Provides health context for the evaluation of the products and/or services.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.diagnosis.diagnosis[x]",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.item.quantity",
"path": "Claim.item.quantity",
"short": "Count of Products or Services",
"definition": "The number of repetitions of a service or product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
]
"type" : [{
"code" : "CodeableConcept"
},
{
"id": "Claim.item.unitPrice",
"path": "Claim.item.unitPrice",
"short": "Fee, charge or cost per point",
"definition": "If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ICD10"
}],
"strength" : "example",
"description" : "Example ICD10 Diagnostic codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/icd-10"
}
},
{
"id" : "Claim.diagnosis.type",
"path" : "Claim.diagnosis.type",
"short" : "Timing or nature of the diagnosis",
"definition" : "When the condition was observed or the relative ranking.",
"comment" : "For example: admitting, primary, secondary, discharge.",
"requirements" : "Often required to capture a particular diagnosis, for example: primary or discharge.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.diagnosis.type",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.factor",
"path": "Claim.item.factor",
"short": "Price scaling factor",
"definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DiagnosisType"
}],
"strength" : "example",
"description" : "The type of the diagnosis: admitting, principal, discharge.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-diagnosistype"
}
},
{
"id" : "Claim.diagnosis.onAdmission",
"path" : "Claim.diagnosis.onAdmission",
"short" : "Present on admission",
"definition" : "Indication of whether the diagnosis was present on admission to a facility.",
"requirements" : "Many systems need to understand for adjudication if the diagnosis was present a time of admission.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.diagnosis.onAdmission",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.net",
"path": "Claim.item.net",
"short": "Total item cost",
"definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DiagnosisOnAdmission"
}],
"strength" : "example",
"description" : "Present on admission.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission"
}
},
{
"id" : "Claim.diagnosis.packageCode",
"path" : "Claim.diagnosis.packageCode",
"short" : "Package billing code",
"definition" : "A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.",
"comment" : "For example DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardial Infarction and a DRG for HeartAttack would be assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event.",
"requirements" : "Required to relate the current diagnosis to a package billing code that is then referenced on the individual claim items which are specific to the health condition covered by the package code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.diagnosis.packageCode",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.udi",
"path": "Claim.item.udi",
"short": "Unique Device Identifier",
"definition": "List of Unique Device Identifiers associated with this line item.",
"requirements": "The UDI code and issuer if applicable for the supplied product.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DiagnosisRelatedGroup"
}],
"strength" : "example",
"description" : "The DRG codes associated with the diagnosis.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup"
}
},
{
"id" : "Claim.procedure",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Procedure"
}],
"path" : "Claim.procedure",
"short" : "Clinical procedures performed",
"definition" : "Procedures performed on the patient relevant to the billing items with the claim.",
"requirements" : "The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.procedure",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.bodySite",
"path": "Claim.item.bodySite",
"short": "Service Location",
"definition": "Physical service site on the patient (limb, tooth, etc).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "OralSites"
}
],
"strength": "example",
"description": "The code for the teeth, quadrant, sextant and arch",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/tooth"
}
}
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.procedure.id",
"path" : "Claim.procedure.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.subSite",
"path": "Claim.item.subSite",
"short": "Service Sub-location",
"definition": "A region or surface of the site, eg. limb region or tooth surface(s).",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Surface"
}
],
"strength": "example",
"description": "The code for the tooth surface and surface combinations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/surface"
}
}
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.procedure.extension",
"path" : "Claim.procedure.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.encounter",
"path": "Claim.item.encounter",
"short": "Encounters related to this billed item",
"definition": "A billed item may include goods or services provided in multiple encounters.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.context"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.item.detail",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Detail"
}
],
"path": "Claim.item.detail",
"short": "Additional items",
"definition": "Second tier of goods and services.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.procedure.modifierExtension",
"path" : "Claim.procedure.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.detail.id",
"path": "Claim.item.detail.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.item.detail.extension",
"path": "Claim.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.procedure.sequence",
"path" : "Claim.procedure.sequence",
"short" : "Procedure instance identifier",
"definition" : "A number to uniquely identify procedure entries.",
"requirements" : "Necessary to provide a mechanism to link to claim details.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.procedure.sequence",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.item.detail.modifierExtension",
"path": "Claim.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.procedure.type",
"path" : "Claim.procedure.type",
"short" : "Category of Procedure",
"definition" : "When the condition was observed or the relative ranking.",
"comment" : "For example: primary, secondary.",
"requirements" : "Often required to capture a particular diagnosis, for example: primary or discharge.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.procedure.type",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.detail.sequence",
"path": "Claim.item.detail.sequence",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureType"
}],
"strength" : "example",
"description" : "Example procedure type codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-procedure-type"
}
},
{
"id" : "Claim.procedure.date",
"path" : "Claim.procedure.date",
"short" : "When the procedure was performed",
"definition" : "Date and optionally time the procedure was performed.",
"requirements" : "Required for auditing purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.procedure.date",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.detail.revenue",
"path": "Claim.item.detail.revenue",
"short": "Revenue or cost center code",
"definition": "The type of reveneu or cost center providing the product and/or service.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RevenueCenter"
}
],
"strength": "example",
"description": "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
}
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.procedure.procedure[x]",
"path" : "Claim.procedure.procedure[x]",
"short" : "Specific clinical procedure",
"definition" : "The code or reference to a Procedure resource which identifies the clinical intervention performed.",
"requirements" : "This identifies the actual clinical procedure.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.procedure.procedure[x]",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.item.detail.category",
"path": "Claim.item.detail.category",
"short": "Type of service or product",
"definition": "Health Care Service Type Codes to identify the classification of service or benefits.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BenefitSubCategory"
}
],
"strength": "example",
"description": "Benefit subcategories such as: oral-basic, major, glasses",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory"
}
}
"type" : [{
"code" : "CodeableConcept"
},
{
"id": "Claim.item.detail.service",
"path": "Claim.item.detail.service",
"short": "Billing Code",
"definition": "If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceProduct"
}
],
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-uscls"
}
}
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Procedure"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ICD10_Procedures"
}],
"strength" : "example",
"description" : "Example ICD10 Procedure codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/icd-10-procedures"
}
},
{
"id" : "Claim.procedure.udi",
"path" : "Claim.procedure.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.procedure.udi",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.detail.modifier",
"path": "Claim.item.detail.modifier",
"short": "Service/Product billing modifiers",
"definition": "Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Modifiers"
}
],
"strength": "example",
"description": "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
}
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.insurance",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Insurance"
}],
"path" : "Claim.insurance",
"short" : "Patient insurance information",
"definition" : "Financial instruments for reimbursement for the health care products and services specified on the claim.",
"comment" : "All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.",
"requirements" : "At least one insurer is required for a claim to be a claim.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Claim.insurance",
"min" : 1,
"max" : "*"
},
{
"id": "Claim.item.detail.programCode",
"path": "Claim.item.detail.programCode",
"short": "Program specific reason for item inclusion",
"definition": "For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ProgramCode"
}
],
"strength": "example",
"description": "Program specific reason codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-program-code"
}
}
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "Coverage"
}]
},
{
"id" : "Claim.insurance.id",
"path" : "Claim.insurance.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.detail.quantity",
"path": "Claim.item.detail.quantity",
"short": "Count of Products or Services",
"definition": "The number of repetitions of a service or product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
]
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.insurance.extension",
"path" : "Claim.insurance.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.detail.unitPrice",
"path": "Claim.item.detail.unitPrice",
"short": "Fee, charge or cost per point",
"definition": "If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.item.detail.factor",
"path": "Claim.item.detail.factor",
"short": "Price scaling factor",
"definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.insurance.modifierExtension",
"path" : "Claim.insurance.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.detail.net",
"path": "Claim.item.detail.net",
"short": "Total additional item cost",
"definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.item.detail.udi",
"path": "Claim.item.detail.udi",
"short": "Unique Device Identifier",
"definition": "List of Unique Device Identifiers associated with this line item.",
"requirements": "The UDI code and issuer if applicable for the supplied product.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.insurance.sequence",
"path" : "Claim.insurance.sequence",
"short" : "Insurance instance identifier",
"definition" : "A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.",
"requirements" : "To maintain order of the coverages.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.insurance.sequence",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.item.detail.subDetail",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "SubDetail"
}
],
"path": "Claim.item.detail.subDetail",
"short": "Additional items",
"definition": "Third tier of goods and services.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Claim.insurance.focal",
"path" : "Claim.insurance.focal",
"short" : "Coverage to be used for adjudication",
"definition" : "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.",
"comment" : "A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.",
"requirements" : "To identify which coverage in the list is being used to adjudicate this claim.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.insurance.focal",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.item.detail.subDetail.id",
"path": "Claim.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). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Claim.insurance.identifier",
"path" : "Claim.insurance.identifier",
"short" : "Pre-assigned Claim number",
"definition" : "The business identifier to be used when the claim is sent for adjudication against this insurance policy.",
"comment" : "Only required in jurisdictions where insurers, rather than the provider, are required to send claims to insurers that appear after them in the list. This element is not required when 'subrogation=true'.",
"requirements" : "This will be the claim number should it be necessary to create this claim in the future. This is provided so that payors may forward claims to other payors in the Coordination of Benefit for adjudication rather than the provider being required to initiate each adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.insurance.identifier",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.detail.subDetail.extension",
"path": "Claim.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"id": "Claim.item.detail.subDetail.modifierExtension",
"path": "Claim.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Claim.insurance.coverage",
"path" : "Claim.insurance.coverage",
"short" : "Insurance information",
"definition" : "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.",
"requirements" : "Required to allow the adjudicator to locate the correct policy and history within their information system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.insurance.coverage",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.item.detail.subDetail.sequence",
"path": "Claim.item.detail.subDetail.sequence",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Claim.insurance.businessArrangement",
"path" : "Claim.insurance.businessArrangement",
"short" : "Additional provider contract number",
"definition" : "A business agreement number established between the provider and the insurer for special business processing purposes.",
"requirements" : "Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.insurance.businessArrangement",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.detail.subDetail.revenue",
"path": "Claim.item.detail.subDetail.revenue",
"short": "Revenue or cost center code",
"definition": "The type of reveneu or cost center providing the product and/or service.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RevenueCenter"
}
],
"strength": "example",
"description": "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
}
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.insurance.preAuthRef",
"path" : "Claim.insurance.preAuthRef",
"short" : "Prior authorization reference number",
"definition" : "Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.",
"comment" : "This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier.",
"requirements" : "Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.insurance.preAuthRef",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.detail.subDetail.category",
"path": "Claim.item.detail.subDetail.category",
"short": "Type of service or product",
"definition": "Health Care Service Type Codes to identify the classification of service or benefits.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BenefitSubCategory"
}
],
"strength": "example",
"description": "Benefit subcategories such as: oral-basic, major, glasses",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory"
}
}
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.insurance.claimResponse",
"path" : "Claim.insurance.claimResponse",
"short" : "Adjudication results",
"definition" : "The result of the adjudication of the line items for the Coverage specified in this insurance.",
"comment" : "Must not be specified when 'focal=true' for this insurance.",
"requirements" : "An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.insurance.claimResponse",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.detail.subDetail.service",
"path": "Claim.item.detail.subDetail.service",
"short": "Billing Code",
"definition": "A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceProduct"
}
],
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-uscls"
}
}
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ClaimResponse"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.accident",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Accident"
}],
"path" : "Claim.accident",
"short" : "Details of the event",
"definition" : "Details of an accident which resulted in injuries which required the products and services listed in the claim.",
"requirements" : "When healthcare products and services are accident related, benefits may be payable under accident provisions of policies, such as automotive, etc before they are payable under normal health insurance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.accident",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.detail.subDetail.modifier",
"path": "Claim.item.detail.subDetail.modifier",
"short": "Service/Product billing modifiers",
"definition": "Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Modifiers"
}
],
"strength": "example",
"description": "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
}
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.accident.id",
"path" : "Claim.accident.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.detail.subDetail.programCode",
"path": "Claim.item.detail.subDetail.programCode",
"short": "Program specific reason for item inclusion",
"definition": "For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ProgramCode"
}
],
"strength": "example",
"description": "Program specific reason codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-program-code"
}
}
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.accident.extension",
"path" : "Claim.accident.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.detail.subDetail.quantity",
"path": "Claim.item.detail.subDetail.quantity",
"short": "Count of Products or Services",
"definition": "The number of repetitions of a service or product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.item.detail.subDetail.unitPrice",
"path": "Claim.item.detail.subDetail.unitPrice",
"short": "Fee, charge or cost per point",
"definition": "The fee for an addittional service or product or charge.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.accident.modifierExtension",
"path" : "Claim.accident.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.detail.subDetail.factor",
"path": "Claim.item.detail.subDetail.factor",
"short": "Price scaling factor",
"definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.item.detail.subDetail.net",
"path": "Claim.item.detail.subDetail.net",
"short": "Net additional item cost",
"definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.accident.date",
"path" : "Claim.accident.date",
"short" : "When the incident occurred",
"definition" : "Date of an accident event related to the products and services contained in the claim.",
"comment" : "The date of the accident has to precede the dates of the products and services but within a reasonable timeframe.",
"requirements" : "Required for audit purposes and adjudication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.accident.date",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.item.detail.subDetail.udi",
"path": "Claim.item.detail.subDetail.udi",
"short": "Unique Device Identifier",
"definition": "List of Unique Device Identifiers associated with this line item.",
"requirements": "The UDI code and issuer if applicable for the supplied product.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
]
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.accident.type",
"path" : "Claim.accident.type",
"short" : "The nature of the accident",
"definition" : "The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.",
"requirements" : "Coverage may be dependant on the type of accident.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.accident.type",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.total",
"path": "Claim.total",
"short": "Total claim cost",
"definition": "The total value of the claim.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AccidentType"
}],
"strength" : "extensible",
"description" : "Type of accident: work place, auto, etc.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActIncidentCode"
}
]
},
"differential": {
"element": [
{
"id": "Claim",
"path": "Claim",
"short": "Claim, Pre-determination or Pre-authorization",
"definition": "A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "workflow",
"map": "Request"
},
{
"identity": "w5",
"map": "financial.billing"
}
]
},
{
"id": "Claim.identifier",
"path": "Claim.identifier",
"short": "Claim number",
"definition": "The business identifier for the instance: claim number, pre-determination or pre-authorization number.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Claim.status",
"path": "Claim.status",
"short": "active | cancelled | draft | entered-in-error",
"definition": "The status of the resource instance.",
"comment": "This element is labeled as a modifier because the status contains the code entered-in-error that marks the claim as not currently valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ClaimStatus"
}
],
"strength": "required",
"description": "A code specifying the state of the resource instance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/fm-status"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Claim.type",
"path": "Claim.type",
"short": "Type or discipline",
"definition": "The category of claim, eg, oral, pharmacy, vision, insitutional, professional.",
"comment": "Affects which fields and value sets are used.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ClaimType"
}
],
"strength": "required",
"description": "The type or discipline-style of the claim",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-type"
}
},
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Claim.subType",
"path": "Claim.subType",
"short": "Finer grained claim type information",
"definition": "A finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType.",
"comment": "This may contain the local bill type codes such as the US UB-04 bill type code.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ClaimSubType"
}
],
"strength": "example",
"description": "A more granular claim typecode",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-subtype"
}
},
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Claim.use",
"path": "Claim.use",
"short": "complete | proposed | exploratory | other",
"definition": "Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Use"
}
],
"strength": "required",
"description": "Complete, proposed, exploratory, other",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-use"
}
},
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Claim.patient",
"path": "Claim.patient",
"short": "The subject of the Products and Services",
"definition": "Patient Resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.subject"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "Claim.billablePeriod",
"path": "Claim.billablePeriod",
"short": "Period for charge submission",
"definition": "The billable period for which charges are being submitted.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "Claim.created",
"path": "Claim.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": "workflow",
"map": "Request.authoredOn"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "Claim.enterer",
"path": "Claim.enterer",
"short": "Author",
"definition": "Person who created the invoice/claim/pre-determination or pre-authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.author"
}
]
},
{
"id": "Claim.insurer",
"path": "Claim.insurer",
"short": "Target",
"definition": "The Insurer who is target of the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.performer"
}
]
},
{
"id": "Claim.provider",
"path": "Claim.provider",
"short": "Responsible provider",
"definition": "The provider which is responsible for the bill, claim pre-determination, pre-authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.requester.agent"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "Claim.organization",
"path": "Claim.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the bill, claim pre-determination, pre-authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.requester.onBehalfOf"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "Claim.priority",
"path": "Claim.priority",
"short": "Desired processing priority",
"definition": "Immediate (STAT), best effort (NORMAL), deferred (DEFER).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ProcessPriority"
}
],
"strength": "example",
"description": "The timeliness with which processing is required: STAT, normal, Deferred",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/process-priority"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.priority"
}
]
},
{
"id": "Claim.fundsReserve",
"path": "Claim.fundsReserve",
"short": "Funds requested to be reserved",
"definition": "In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FundsReserve"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "example",
"description": "For whom funds are to be reserved: (Patient, Provider, None).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/fundsreserve"
}
}
},
{
"id": "Claim.related",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "RelatedClaim"
}
],
"path": "Claim.related",
"short": "Related Claims which may be revelant to processing this claimn",
"definition": "Other claims which are related to this claim such as prior claim versions or for related services.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "Claim.related.claim",
"path": "Claim.related.claim",
"short": "Reference to the related claim",
"definition": "Other claims which are related to this claim such as prior claim versions or for related services.",
"comment": "Do we need a relationship code?",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Claim"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.replaces"
}
]
},
{
"id" : "Claim.accident.location[x]",
"path" : "Claim.accident.location[x]",
"short" : "Where the event occurred",
"definition" : "The physical location of the accident event.",
"requirements" : "Required for audit purposes and determination of applicable insurance liability.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.accident.location[x]",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.related.relationship",
"path": "Claim.related.relationship",
"short": "How the reference claim is related",
"definition": "For example prior or umbrella.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedClaimRelationship"
}
],
"strength": "example",
"description": "Relationship of this claim to a related Claim",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/related-claim-relationship"
}
}
"type" : [{
"code" : "Address"
},
{
"id": "Claim.related.reference",
"path": "Claim.related.reference",
"short": "Related file or case reference",
"definition": "An alternate organizational reference to the case or file to which this particular claim pertains - eg Property/Casualy insurer claim # or Workers Compensation case # .",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Item"
}],
"path" : "Claim.item",
"short" : "Product or service provided",
"definition" : "A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.",
"requirements" : "The items to be processed for adjudication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.prescription",
"path": "Claim.prescription",
"short": "Prescription authorizing services or products",
"definition": "Prescription to support the dispensing of Pharmacy or Vision products.",
"comment": "Should we create a group to hold multiple prescriptions and add a sequence number and on the line items a link to the sequence.",
"requirements": "For type=Pharmacy and Vision only.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/VisionPrescription"
}
]
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.id",
"path" : "Claim.item.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.originalPrescription",
"path": "Claim.originalPrescription",
"short": "Original prescription if superceded by fulfiller",
"definition": "Original prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.",
"comment": "as above.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest"
}
]
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.item.extension",
"path" : "Claim.item.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.payee",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Payee"
}
],
"path": "Claim.payee",
"short": "Party to be paid any benefits payable",
"definition": "The party to be reimbursed for the services.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.payee.type",
"path": "Claim.payee.type",
"short": "Type of party: Subscriber, Provider, other",
"definition": "Type of Party to be reimbursed: Subscriber, provider, other.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PayeeType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "example",
"description": "A code for the party to be reimbursed.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/payeetype"
}
}
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.item.modifierExtension",
"path" : "Claim.item.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.payee.resourceType",
"path": "Claim.payee.resourceType",
"short": "organization | patient | practitioner | relatedperson",
"definition": "organization | patient | practitioner | relatedperson.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ClaimPayeeResourceType"
}
],
"strength": "example",
"description": "The type of Claim payee Resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-payee-resource-type"
}
}
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.payee.party",
"path": "Claim.payee.party",
"short": "Party to receive the payable",
"definition": "Party to be reimbursed: Subscriber, provider, other.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.item.sequence",
"path" : "Claim.item.sequence",
"short" : "Item instance identifier",
"definition" : "A number to uniquely identify item entries.",
"requirements" : "Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.item.sequence",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.referral",
"path": "Claim.referral",
"short": "Treatment Referral",
"definition": "The referral resource which lists the date, practitioner, reason and other supporting information.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.cause"
}
]
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.careTeamSequence",
"path" : "Claim.item.careTeamSequence",
"short" : "Applicable careTeam members",
"definition" : "CareTeam members related to this service or product.",
"requirements" : "Need to identify the individuals and their roles in the provision of the product or service.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.careTeamSequence",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.facility",
"path": "Claim.facility",
"short": "Servicing Facility",
"definition": "Facility where the services were provided.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "w5",
"map": "where"
}
]
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.diagnosisSequence",
"path" : "Claim.item.diagnosisSequence",
"short" : "Applicable diagnoses",
"definition" : "Diagnosis applicable for this service or product.",
"requirements" : "Need to related the product or service to the associated diagnoses.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.diagnosisSequence",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.careTeam",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "CareTeam"
}
],
"path": "Claim.careTeam",
"short": "Members of the care team",
"definition": "The members of the team who provided the overall service as well as their role and whether responsible and qualifications.",
"requirements": "Role and Responsible may not be required when there is only a single provider listed.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.procedureSequence",
"path" : "Claim.item.procedureSequence",
"short" : "Applicable procedures",
"definition" : "Procedures applicable for this service or product.",
"requirements" : "Need to provide any listed specific procedures to support the product or service being claimed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.procedureSequence",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.careTeam.sequence",
"path": "Claim.careTeam.sequence",
"short": "Number to covey order of careTeam",
"definition": "Sequence of the careTeam which serves to order and provide a link.",
"requirements": "Required to maintain order of the careTeam.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.informationSequence",
"path" : "Claim.item.informationSequence",
"short" : "Applicable exception and supporting information",
"definition" : "Exceptions, special conditions and supporting information applicable for this service or product.",
"requirements" : "Need to reference the supporting information items that relate directly to this product or service.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.informationSequence",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.careTeam.provider",
"path": "Claim.careTeam.provider",
"short": "Provider individual or organization",
"definition": "Member of the team who provided the overall service.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.actor"
}
]
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.revenue",
"path" : "Claim.item.revenue",
"short" : "Revenue or cost center code",
"definition" : "The type of revenue or cost center providing the product and/or service.",
"requirements" : "Needed in the processing of institutional claims.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.revenue",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.careTeam.responsible",
"path": "Claim.careTeam.responsible",
"short": "Billing provider",
"definition": "The party who is billing and responsible for the claimed good or service rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RevenueCenter"
}],
"strength" : "example",
"description" : "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
},
{
"id" : "Claim.item.category",
"path" : "Claim.item.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.category",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.careTeam.role",
"path": "Claim.careTeam.role",
"short": "Role on the team",
"definition": "The lead, assisting or supervising practitioner and their discipline if a multidisiplinary team.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CareTeamRole"
}
],
"strength": "example",
"description": "The role codes for the care team members.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-careteamrole"
}
}
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral-basic, major, glasses.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "Claim.item.productOrService",
"path" : "Claim.item.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"alias" : ["Drug Code",
"Bill Code",
"Service Code"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.item.productOrService",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.careTeam.qualification",
"path": "Claim.careTeam.qualification",
"short": "Type, classification or Specialization",
"definition": "The qualification which is applicable for this service.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ProviderQualification"
}
],
"strength": "example",
"description": "Provider professional qualifications",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/provider-qualification"
}
}
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "Claim.item.modifier",
"path" : "Claim.item.modifier",
"short" : "Product or service billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.modifier",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.information",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "SpecialCondition"
}
],
"path": "Claim.information",
"short": "Exceptions, special considerations, the condition, situation, prior or concurrent issues",
"definition": "Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are mutiple jurisdiction specific valuesets which are required.",
"requirements": "Typically these information codes are required to support the services rendered or the adjudication of the services rendered.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.supportingInfo"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "Claim.item.programCode",
"path" : "Claim.item.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.programCode",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.information.sequence",
"path": "Claim.information.sequence",
"short": "Information instance identifier",
"definition": "Sequence of the information element which serves to provide a link.",
"requirements": "To provide a reference link.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
}
},
{
"id" : "Claim.item.serviced[x]",
"path" : "Claim.item.serviced[x]",
"short" : "Date or dates of service or product delivery",
"definition" : "The date or dates when the service or product was supplied, performed or completed.",
"requirements" : "Needed to determine whether the service or product was provided during the term of the insurance coverage.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.serviced[x]",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.information.category",
"path": "Claim.information.category",
"short": "General class of information",
"definition": "The general class of the information supplied: information; exception; accident, employment; onset, etc.",
"comment": "This may contain the local bill type codes such as the US UB-04 bill type code.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "InformationCategory"
}
],
"strength": "example",
"description": "The valuset used for additional information category codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-informationcategory"
}
}
"type" : [{
"code" : "date"
},
{
"id": "Claim.information.code",
"path": "Claim.information.code",
"short": "Type of information",
"definition": "System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought which may influence the adjudication.",
"comment": "This may contain the local bill type codes such as the US UB-04 bill type code.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "InformationCode"
}
],
"strength": "example",
"description": "The valuset used for additional information codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-exception"
}
}
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Claim.item.location[x]",
"path" : "Claim.item.location[x]",
"short" : "Place of service or where product was supplied",
"definition" : "Where the product or service was provided.",
"requirements" : "The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.location[x]",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.information.timing[x]",
"path": "Claim.information.timing[x]",
"short": "When it occurred",
"definition": "The date when or period to which this information refers.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
},
{
"code": "Period"
}
]
"type" : [{
"code" : "CodeableConcept"
},
{
"id": "Claim.information.value[x]",
"path": "Claim.information.value[x]",
"short": "Additional Data or supporting information",
"definition": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
},
{
"code": "Quantity"
},
{
"code": "Attachment"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
"code" : "Address"
},
{
"id": "Claim.information.reason",
"path": "Claim.information.reason",
"short": "Reason associated with the information",
"definition": "For example, provides the reason for: the additional stay, or missing tooth or any other situation where a reason code is required in addition to the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MissingReason"
}
],
"strength": "example",
"description": "Reason codes for the missing teeth",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/missing-tooth-reason"
}
}
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServicePlace"
}],
"strength" : "example",
"description" : "Place of service: pharmacy, school, prison, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-place"
},
{
"id": "Claim.diagnosis",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Diagnosis"
}
],
"path": "Claim.diagnosis",
"short": "List of Diagnosis",
"definition": "List of patient diagnosis for which care is sought.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.reasonReference"
}
]
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
}]
},
{
"id" : "Claim.item.quantity",
"path" : "Claim.item.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.quantity",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.diagnosis.sequence",
"path": "Claim.diagnosis.sequence",
"short": "Number to covey order of diagnosis",
"definition": "Sequence of diagnosis which serves to provide a link.",
"requirements": "Required to allow line items to reference the diagnoses.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.unitPrice",
"path" : "Claim.item.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.unitPrice",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.diagnosis.diagnosis[x]",
"path": "Claim.diagnosis.diagnosis[x]",
"short": "Patient's diagnosis",
"definition": "The diagnosis.",
"requirements": "Required to adjudicate services rendered to condition presented.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ICD10"
}
],
"strength": "example",
"description": "ICD10 Diagnostic codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/icd-10"
}
}
"type" : [{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.factor",
"path" : "Claim.item.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.factor",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.diagnosis.type",
"path": "Claim.diagnosis.type",
"short": "Timing or nature of the diagnosis",
"definition": "The type of the Diagnosis, for example: admitting, primary, secondary, discharge.",
"comment": "Diagnosis are presented in list order to their expected importance: primary, secondary, etc.",
"requirements": "May be required to adjudicate services rendered.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DiagnosisType"
}
],
"strength": "example",
"description": "The type of the diagnosis: admitting, principal, discharge",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-diagnosistype"
}
}
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.net",
"path" : "Claim.item.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.net",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.diagnosis.packageCode",
"path": "Claim.diagnosis.packageCode",
"short": "Package billing code",
"definition": "The package billing code, for example DRG, based on the assigned grouping code system.",
"requirements": "May be required to adjudicate services rendered to the mandated grouping system.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DiagnosisRelatedGroup"
}
],
"strength": "example",
"description": "The DRG codes associated with the diagnosis",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup"
}
}
"type" : [{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.udi",
"path" : "Claim.item.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.udi",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.procedure",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Procedure"
}
],
"path": "Claim.procedure",
"short": "Procedures performed",
"definition": "Ordered list of patient procedures performed to support the adjudication.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.bodySite",
"path" : "Claim.item.bodySite",
"short" : "Anatomical location",
"definition" : "Physical service site on the patient (limb, tooth, etc.).",
"comment" : "For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed.",
"requirements" : "Allows insurer to validate specific procedures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.bodySite",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.procedure.sequence",
"path": "Claim.procedure.sequence",
"short": "Procedure sequence for reference",
"definition": "Sequence of procedures which serves to order and provide a link.",
"requirements": "Required to maintain order of the procudures.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OralSites"
}],
"strength" : "example",
"description" : "The code for the teeth, quadrant, sextant and arch.",
"valueSet" : "http://hl7.org/fhir/ValueSet/tooth"
}
},
{
"id" : "Claim.item.subSite",
"path" : "Claim.item.subSite",
"short" : "Anatomical sub-location",
"definition" : "A region or surface of the bodySite, e.g. limb region or tooth surface(s).",
"requirements" : "Allows insurer to validate specific procedures.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.subSite",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.procedure.date",
"path": "Claim.procedure.date",
"short": "When the procedure was performed",
"definition": "Date and optionally time the procedure was performed .",
"comment": "SB DateTime??",
"requirements": "Required to adjudicate services rendered.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Surface"
}],
"strength" : "example",
"description" : "The code for the tooth surface and surface combinations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/surface"
}
},
{
"id" : "Claim.item.encounter",
"path" : "Claim.item.encounter",
"short" : "Encounters related to this billed item",
"definition" : "The Encounters during which this Claim was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"requirements" : "Used in some jurisdictions to link clinical events to claim items.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.encounter",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.procedure.procedure[x]",
"path": "Claim.procedure.procedure[x]",
"short": "Patient's list of procedures performed",
"definition": "The procedure code.",
"requirements": "Required to adjudicate services rendered.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ICD10_Procedures"
}
],
"strength": "example",
"description": "ICD10 Procedure codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/icd-10-procedures"
}
}
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context"
}]
},
{
"id" : "Claim.item.detail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Detail"
}],
"path" : "Claim.item.detail",
"short" : "Product or service provided",
"definition" : "A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.",
"requirements" : "The items to be processed for adjudication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.insurance",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Insurance"
}
],
"path": "Claim.insurance",
"short": "Insurance or medical plan",
"definition": "Financial instrument by which payment information for health care.",
"requirements": "Health care programs and insurers are significant payors of health service costs.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": "Coverage"
}
]
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.id",
"path" : "Claim.item.detail.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.insurance.sequence",
"path": "Claim.insurance.sequence",
"short": "Service instance identifier",
"definition": "Sequence of coverage which serves to provide a link and convey coordination of benefit order.",
"requirements": "To maintain order of the coverages.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.item.detail.extension",
"path" : "Claim.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.insurance.focal",
"path": "Claim.insurance.focal",
"short": "Is the focal Coverage",
"definition": "A flag to indicate that this Coverage is the focus for adjudication. The Coverage against which the claim is to be adjudicated.",
"requirements": "To identify which coverage is being adjudicated.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.insurance.coverage",
"path": "Claim.insurance.coverage",
"short": "Insurance information",
"definition": "Reference to the program or plan identification, underwriter or payor.",
"requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Coverage"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.item.detail.modifierExtension",
"path" : "Claim.item.detail.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.insurance.businessArrangement",
"path": "Claim.insurance.businessArrangement",
"short": "Business agreement",
"definition": "The contract number of a business agreement which describes the terms and conditions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.insurance.preAuthRef",
"path": "Claim.insurance.preAuthRef",
"short": "Pre-Authorization/Determination Reference",
"definition": "A list of references from the Insurer to which these services pertain.",
"requirements": "To provide any pre=determination or prior authorization reference.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.item.detail.sequence",
"path" : "Claim.item.detail.sequence",
"short" : "Item instance identifier",
"definition" : "A number to uniquely identify item entries.",
"requirements" : "Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.sequence",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.insurance.claimResponse",
"path": "Claim.insurance.claimResponse",
"short": "Adjudication results",
"definition": "The Coverages adjudication details.",
"requirements": "Used by downstream payers to determine what balance remains and the net payable.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ClaimResponse"
}
]
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.revenue",
"path" : "Claim.item.detail.revenue",
"short" : "Revenue or cost center code",
"definition" : "The type of revenue or cost center providing the product and/or service.",
"requirements" : "Needed in the processing of institutional claims.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.revenue",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.accident",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Accident"
}
],
"path": "Claim.accident",
"short": "Details about an accident",
"definition": "An accident which resulted in the need for healthcare services.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RevenueCenter"
}],
"strength" : "example",
"description" : "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
},
{
"id" : "Claim.item.detail.category",
"path" : "Claim.item.detail.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.category",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.accident.date",
"path": "Claim.accident.date",
"short": "When the accident occurred\nsee information codes\nsee information codes",
"definition": "Date of an accident which these services are addressing.",
"requirements": "Coverage may be dependant on accidents.",
"min": 1,
"max": "1",
"type": [
{
"code": "date"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral-basic, major, glasses.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "Claim.item.detail.productOrService",
"path" : "Claim.item.detail.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"alias" : ["Drug Code",
"Bill Code",
"Service Code"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.productOrService",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.accident.type",
"path": "Claim.accident.type",
"short": "The nature of the accident",
"definition": "Type of accident: work, auto, etc.",
"requirements": "Coverage may be dependant on the type of accident.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AccidentType"
}
],
"strength": "required",
"description": "Type of accident: work place, auto, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ActIncidentCode"
}
}
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "Claim.item.detail.modifier",
"path" : "Claim.item.detail.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.modifier",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.accident.location[x]",
"path": "Claim.accident.location[x]",
"short": "Accident Place",
"definition": "Accident Place.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "Claim.item.detail.programCode",
"path" : "Claim.item.detail.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.programCode",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.employmentImpacted",
"path": "Claim.employmentImpacted",
"short": "Period unable to work",
"definition": "The start and optional end dates of when the patient was precluded from working due to the treatable condition(s).",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
}
},
{
"id" : "Claim.item.detail.quantity",
"path" : "Claim.item.detail.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.quantity",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.hospitalization",
"path": "Claim.hospitalization",
"short": "Period in hospital",
"definition": "The start and optional end dates of when the patient was confined to a treatment center.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.unitPrice",
"path" : "Claim.item.detail.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.unitPrice",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Item"
}
],
"path": "Claim.item",
"short": "Goods and Services",
"definition": "First tier of goods and services.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
"type" : [{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.factor",
"path" : "Claim.item.detail.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.factor",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.sequence",
"path": "Claim.item.sequence",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.net",
"path" : "Claim.item.detail.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.net",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.careTeamLinkId",
"path": "Claim.item.careTeamLinkId",
"short": "Applicable careTeam members",
"definition": "CareTeam applicable for this service or product line.",
"min": 0,
"max": "*",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.udi",
"path" : "Claim.item.detail.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.udi",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.diagnosisLinkId",
"path": "Claim.item.diagnosisLinkId",
"short": "Applicable diagnoses",
"definition": "Diagnosis applicable for this service or product line.",
"min": 0,
"max": "*",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SubDetail"
}],
"path" : "Claim.item.detail.subDetail",
"short" : "Product or service provided",
"definition" : "A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.",
"requirements" : "The items to be processed for adjudication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.subDetail",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.procedureLinkId",
"path": "Claim.item.procedureLinkId",
"short": "Applicable procedures",
"definition": "Procedures applicable for this service or product line.",
"min": 0,
"max": "*",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail.id",
"path" : "Claim.item.detail.subDetail.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.informationLinkId",
"path": "Claim.item.informationLinkId",
"short": "Applicable exception and supporting information",
"definition": "Exceptions, special conditions and supporting information pplicable for this service or product line.",
"min": 0,
"max": "*",
"type": [
{
"code": "positiveInt"
}
]
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.item.detail.subDetail.extension",
"path" : "Claim.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.revenue",
"path": "Claim.item.revenue",
"short": "Revenue or cost center code",
"definition": "The type of reveneu or cost center providing the product and/or service.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RevenueCenter"
}
],
"strength": "example",
"description": "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
}
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.item.category",
"path": "Claim.item.category",
"short": "Type of service or product",
"definition": "Health Care Service Type Codes to identify the classification of service or benefits.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BenefitSubCategory"
}
],
"strength": "example",
"description": "Benefit subcategories such as: oral-basic, major, glasses",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory"
}
}
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Claim.item.detail.subDetail.modifierExtension",
"path" : "Claim.item.detail.subDetail.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.service",
"path": "Claim.item.service",
"short": "Billing Code",
"definition": "If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,RXNorm,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceProduct"
}
],
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-uscls"
}
}
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "Claim.item.modifier",
"path": "Claim.item.modifier",
"short": "Service/Product billing modifiers",
"definition": "Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Modifiers"
}
],
"strength": "example",
"description": "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
}
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Claim.item.detail.subDetail.sequence",
"path" : "Claim.item.detail.subDetail.sequence",
"short" : "Item instance identifier",
"definition" : "A number to uniquely identify item entries.",
"requirements" : "Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.sequence",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.item.programCode",
"path": "Claim.item.programCode",
"short": "Program specific reason for item inclusion",
"definition": "For programs which require reason codes for the inclusion or covering of this billed item under the program or sub-program.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ProgramCode"
}
],
"strength": "example",
"description": "Program specific reason codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-program-code"
}
}
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail.revenue",
"path" : "Claim.item.detail.subDetail.revenue",
"short" : "Revenue or cost center code",
"definition" : "The type of revenue or cost center providing the product and/or service.",
"requirements" : "Needed in the processing of institutional claims.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.revenue",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.serviced[x]",
"path": "Claim.item.serviced[x]",
"short": "Date or dates of Service",
"definition": "The date or dates when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
},
{
"code": "Period"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.done"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RevenueCenter"
}],
"strength" : "example",
"description" : "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
},
{
"id" : "Claim.item.detail.subDetail.category",
"path" : "Claim.item.detail.subDetail.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.category",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.location[x]",
"path": "Claim.item.location[x]",
"short": "Place of service",
"definition": "Where the service was provided.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Address"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServicePlace"
}
],
"strength": "example",
"description": "Place of service: pharmacy,school, prison, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-place"
}
},
"mapping": [
{
"identity": "w5",
"map": "where"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral-basic, major, glasses.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "Claim.item.detail.subDetail.productOrService",
"path" : "Claim.item.detail.subDetail.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.productOrService",
"min" : 1,
"max" : "1"
},
{
"id": "Claim.item.quantity",
"path": "Claim.item.quantity",
"short": "Count of Products or Services",
"definition": "The number of repetitions of a service or product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "Claim.item.detail.subDetail.modifier",
"path" : "Claim.item.detail.subDetail.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.subDetail.modifier",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.unitPrice",
"path": "Claim.item.unitPrice",
"short": "Fee, charge or cost per point",
"definition": "If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "Claim.item.detail.subDetail.programCode",
"path" : "Claim.item.detail.subDetail.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.subDetail.programCode",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.factor",
"path": "Claim.item.factor",
"short": "Price scaling factor",
"definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
}
},
{
"id" : "Claim.item.detail.subDetail.quantity",
"path" : "Claim.item.detail.subDetail.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.quantity",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.net",
"path": "Claim.item.net",
"short": "Total item cost",
"definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail.unitPrice",
"path" : "Claim.item.detail.subDetail.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.unitPrice",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.udi",
"path": "Claim.item.udi",
"short": "Unique Device Identifier",
"definition": "List of Unique Device Identifiers associated with this line item.",
"requirements": "The UDI code and issuer if applicable for the supplied product.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
]
"type" : [{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail.factor",
"path" : "Claim.item.detail.subDetail.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.factor",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.bodySite",
"path": "Claim.item.bodySite",
"short": "Service Location",
"definition": "Physical service site on the patient (limb, tooth, etc).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "OralSites"
}
],
"strength": "example",
"description": "The code for the teeth, quadrant, sextant and arch",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/tooth"
}
}
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail.net",
"path" : "Claim.item.detail.subDetail.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.item.detail.subDetail.net",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.subSite",
"path": "Claim.item.subSite",
"short": "Service Sub-location",
"definition": "A region or surface of the site, eg. limb region or tooth surface(s).",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Surface"
}
],
"strength": "example",
"description": "The code for the tooth surface and surface combinations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/surface"
}
}
"type" : [{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.item.detail.subDetail.udi",
"path" : "Claim.item.detail.subDetail.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Claim.item.detail.subDetail.udi",
"min" : 0,
"max" : "*"
},
{
"id": "Claim.item.encounter",
"path": "Claim.item.encounter",
"short": "Encounters related to this billed item",
"definition": "A billed item may include goods or services provided in multiple encounters.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.context"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Claim.total",
"path" : "Claim.total",
"short" : "Total claim cost",
"definition" : "The total value of the all the items in the claim.",
"requirements" : "Used for control total purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Claim.total",
"min" : 0,
"max" : "1"
},
{
"id": "Claim.item.detail",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Detail"
}
],
"path": "Claim.item.detail",
"short": "Additional items",
"definition": "Second tier of goods and services.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
"type" : [{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "Claim",
"path" : "Claim",
"short" : "Claim, Pre-determination or Pre-authorization",
"definition" : "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.",
"comment" : "The Claim resource fulfills three information request requirements: Claim - a request for adjudication for reimbursement for products and/or services provided; Preauthorization - a request to authorize the future provision of products and/or services including an anticipated adjudication; and, Predetermination - a request for a non-bind adjudication of possible future products and/or services.",
"alias" : ["Adjudication Request",
"Preauthorization Request",
"Predetermination Request"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Request"
}]
},
{
"id" : "Claim.identifier",
"path" : "Claim.identifier",
"short" : "Business Identifier for claim",
"definition" : "A unique identifier assigned to this claim.",
"requirements" : "Allows claims to be distinguished and referenced.",
"alias" : ["Claim Number"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"id": "Claim.item.detail.sequence",
"path": "Claim.item.detail.sequence",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Claim.status",
"path" : "Claim.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.0.1"
},
{
"id": "Claim.item.detail.revenue",
"path": "Claim.item.detail.revenue",
"short": "Revenue or cost center code",
"definition": "The type of reveneu or cost center providing the product and/or service.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RevenueCenter"
}
],
"strength": "example",
"description": "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
}
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"id": "Claim.item.detail.category",
"path": "Claim.item.detail.category",
"short": "Type of service or product",
"definition": "Health Care Service Type Codes to identify the classification of service or benefits.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BenefitSubCategory"
}
],
"strength": "example",
"description": "Benefit subcategories such as: oral-basic, major, glasses",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory"
}
}
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "Claim.type",
"path" : "Claim.type",
"short" : "Category or discipline",
"definition" : "The category of claim, e.g. oral, pharmacy, vision, institutional, professional.",
"comment" : "The majority of jurisdictions use: oral, pharmacy, vision, professional and institutional, or variants on those terms, as the general styles of claims. The valueset is extensible to accommodate other jurisdictional requirements.",
"requirements" : "Claim type determine the general sets of business rules applied for information requirements and adjudication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimType"
}],
"strength" : "extensible",
"description" : "The type or discipline-style of the claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-type"
},
{
"id": "Claim.item.detail.service",
"path": "Claim.item.detail.service",
"short": "Billing Code",
"definition": "If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceProduct"
}
],
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-uscls"
}
}
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Claim.subType",
"path" : "Claim.subType",
"short" : "More granular claim type",
"definition" : "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.",
"comment" : "This may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.",
"requirements" : "Some jurisdictions need a finer grained claim type for routing and adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ClaimSubType"
}],
"strength" : "example",
"description" : "A more granular claim typecode.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-subtype"
},
{
"id": "Claim.item.detail.modifier",
"path": "Claim.item.detail.modifier",
"short": "Service/Product billing modifiers",
"definition": "Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Modifiers"
}
],
"strength": "example",
"description": "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
}
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Claim.use",
"path" : "Claim.use",
"short" : "claim | preauthorization | predetermination",
"definition" : "A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.",
"requirements" : "This element is required to understand the nature of the request for adjudication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Use"
}],
"strength" : "required",
"description" : "The purpose of the Claim: predetermination, preauthorization, claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-use|4.0.1"
},
{
"id": "Claim.item.detail.programCode",
"path": "Claim.item.detail.programCode",
"short": "Program specific reason for item inclusion",
"definition": "For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ProgramCode"
}
],
"strength": "example",
"description": "Program specific reason codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-program-code"
}
}
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Claim.patient",
"path" : "Claim.patient",
"short" : "The recipient of the products and services",
"definition" : "The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.",
"requirements" : "The patient must be supplied to the insurer so that confirmation of coverage and service history may be considered as part of the authorization and/or adjudiction.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"id": "Claim.item.detail.quantity",
"path": "Claim.item.detail.quantity",
"short": "Count of Products or Services",
"definition": "The number of repetitions of a service or product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
]
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"id": "Claim.item.detail.unitPrice",
"path": "Claim.item.detail.unitPrice",
"short": "Fee, charge or cost per point",
"definition": "If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Claim.billablePeriod",
"path" : "Claim.billablePeriod",
"short" : "Relevant time frame for the claim",
"definition" : "The period for which charges are being submitted.",
"comment" : "Typically this would be today or in the past for a claim, and today or in the future for preauthorizations and predeterminations. Typically line item dates of service should fall within the billing period if one is specified.",
"requirements" : "A number jurisdictions required the submission of the billing period when submitting claims for example for hospital stays or long-term care.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Claim.created",
"path" : "Claim.created",
"short" : "Resource creation date",
"definition" : "The date this resource was created.",
"comment" : "This field is independent of the date of creation of the resource as it may reflect the creation date of a source document prior to digitization. Typically for claims all services must be completed as of this date.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"id": "Claim.item.detail.factor",
"path": "Claim.item.detail.factor",
"short": "Price scaling factor",
"definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "Claim.enterer",
"path" : "Claim.enterer",
"short" : "Author of the claim",
"definition" : "Individual who created the claim, predetermination or preauthorization.",
"requirements" : "Some jurisdictions require the contact information for personnel completing claims.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
}]
},
{
"id" : "Claim.insurer",
"path" : "Claim.insurer",
"short" : "Target",
"definition" : "The Insurer who is target of the request.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
}]
},
{
"id" : "Claim.provider",
"path" : "Claim.provider",
"short" : "Party responsible for the claim",
"definition" : "The provider which is responsible for the claim, predetermination or preauthorization.",
"comment" : "Typically this field would be 1..1 where this party is responsible for the claim but not necessarily professionally responsible for the provision of the individual products and services listed below.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"id": "Claim.item.detail.net",
"path": "Claim.item.detail.net",
"short": "Total additional item cost",
"definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"identity" : "w5",
"map" : "FiveWs.source"
}]
},
{
"id" : "Claim.priority",
"path" : "Claim.priority",
"short" : "Desired processing ugency",
"definition" : "The provider-required urgency of processing the request. Typical values include: stat, routine deferred.",
"comment" : "If a claim processor is unable to complete the processing as per the priority then they should generate and error and not process the request.",
"requirements" : "The provider may need to indicate their processing requirements so that the processor can indicate if they are unable to comply.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcessPriority"
}],
"strength" : "example",
"description" : "The timeliness with which processing is required: stat, normal, deferred.",
"valueSet" : "http://hl7.org/fhir/ValueSet/process-priority"
},
{
"id": "Claim.item.detail.udi",
"path": "Claim.item.detail.udi",
"short": "Unique Device Identifier",
"definition": "List of Unique Device Identifiers associated with this line item.",
"requirements": "The UDI code and issuer if applicable for the supplied product.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
]
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
}]
},
{
"id" : "Claim.fundsReserve",
"path" : "Claim.fundsReserve",
"short" : "For whom to reserve funds",
"definition" : "A code to indicate whether and for whom funds are to be reserved for future claims.",
"comment" : "This field is only used for preauthorizations.",
"requirements" : "In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.",
"alias" : ["Fund pre-allocation"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FundsReserve"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "For whom funds are to be reserved: (Patient, Provider, None).",
"valueSet" : "http://hl7.org/fhir/ValueSet/fundsreserve"
}
},
{
"id" : "Claim.related",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "RelatedClaim"
}],
"path" : "Claim.related",
"short" : "Prior or corollary claims",
"definition" : "Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.",
"comment" : "For example, for the original treatment and follow-up exams.",
"requirements" : "For workplace or other accidents it is common to relate separate claims arising from the same event.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.related.claim",
"path" : "Claim.related.claim",
"short" : "Reference to the related claim",
"definition" : "Reference to a related claim.",
"requirements" : "For workplace or other accidents it is common to relate separate claims arising from the same event.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Claim"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
}]
},
{
"id" : "Claim.related.relationship",
"path" : "Claim.related.relationship",
"short" : "How the reference claim is related",
"definition" : "A code to convey how the claims are related.",
"comment" : "For example, prior claim or umbrella.",
"requirements" : "Some insurers need a declaration of the type of relationship.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RelatedClaimRelationship"
}],
"strength" : "example",
"description" : "Relationship of this claim to a related Claim.",
"valueSet" : "http://hl7.org/fhir/ValueSet/related-claim-relationship"
}
},
{
"id" : "Claim.related.reference",
"path" : "Claim.related.reference",
"short" : "File or case reference",
"definition" : "An alternate organizational reference to the case or file to which this particular claim pertains.",
"comment" : "For example, Property/Casualty insurer claim # or Workers Compensation case # .",
"requirements" : "In cases where an event-triggered claim is being submitted to an insurer which requires a reference number to be specified on all exchanges.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}]
},
{
"id" : "Claim.prescription",
"path" : "Claim.prescription",
"short" : "Prescription authorizing services and products",
"definition" : "Prescription to support the dispensing of pharmacy, device or vision products.",
"requirements" : "Required to authorize the dispensing of controlled substances and devices.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/VisionPrescription"]
}]
},
{
"id" : "Claim.originalPrescription",
"path" : "Claim.originalPrescription",
"short" : "Original prescription if superseded by fulfiller",
"definition" : "Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.",
"comment" : "For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefore issues a new prescription for an alternate medication which has the same therapeutic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.",
"requirements" : "Often required when a fulfiller varies what is fulfilled from that authorized on the original prescription.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/VisionPrescription"]
}]
},
{
"id" : "Claim.payee",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Payee"
}],
"path" : "Claim.payee",
"short" : "Recipient of benefits payable",
"definition" : "The party to be reimbursed for cost of the products and services according to the terms of the policy.",
"comment" : "Often providers agree to receive the benefits payable to reduce the near-term costs to the patient. The insurer may decline to pay the provider and choose to pay the subscriber instead.",
"requirements" : "The provider needs to specify who they wish to be reimbursed and the claims processor needs express who they will reimburse.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.payee.type",
"path" : "Claim.payee.type",
"short" : "Category of recipient",
"definition" : "Type of Party to be reimbursed: subscriber, provider, other.",
"requirements" : "Need to know who should receive payment with the most common situations being the Provider (assignment of benefits) or the Subscriber.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PayeeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "A code for the party to be reimbursed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/payeetype"
}
},
{
"id" : "Claim.payee.party",
"path" : "Claim.payee.party",
"short" : "Recipient reference",
"definition" : "Reference to the individual or organization to whom any payment will be made.",
"comment" : "Not required if the payee is 'subscriber' or 'provider'.",
"requirements" : "Need to provide demographics if the payee is not 'subscriber' nor 'provider'.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}]
},
{
"id" : "Claim.referral",
"path" : "Claim.referral",
"short" : "Treatment referral",
"definition" : "A reference to a referral resource.",
"comment" : "The referral resource which lists the date, practitioner, reason and other supporting information.",
"requirements" : "Some insurers require proof of referral to pay for services or to pay specialist rates for services.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.cause"
}]
},
{
"id" : "Claim.facility",
"path" : "Claim.facility",
"short" : "Servicing facility",
"definition" : "Facility where the services were provided.",
"requirements" : "Insurance adjudication can be dependant on where services were delivered.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
}]
},
{
"id" : "Claim.careTeam",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "CareTeam"
}],
"path" : "Claim.careTeam",
"short" : "Members of the care team",
"definition" : "The members of the team who provided the products and services.",
"requirements" : "Common to identify the responsible and supporting practitioners.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.careTeam.sequence",
"path" : "Claim.careTeam.sequence",
"short" : "Order of care team",
"definition" : "A number to uniquely identify care team entries.",
"requirements" : "Necessary to maintain the order of the care team and provide a mechanism to link individuals to claim details.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.careTeam.provider",
"path" : "Claim.careTeam.provider",
"short" : "Practitioner or organization",
"definition" : "Member of the team who provided the product or service.",
"requirements" : "Often a regulatory requirement to specify the responsible provider.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "Claim.careTeam.responsible",
"path" : "Claim.careTeam.responsible",
"short" : "Indicator of the lead practitioner",
"definition" : "The party who is billing and/or responsible for the claimed products or services.",
"comment" : "Responsible might not be required when there is only a single provider listed.",
"requirements" : "When multiple parties are present it is required to distinguish the lead or responsible individual.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "Claim.careTeam.role",
"path" : "Claim.careTeam.role",
"short" : "Function within the team",
"definition" : "The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.",
"comment" : "Role might not be required when there is only a single provider listed.",
"requirements" : "When multiple parties are present it is required to distinguish the roles performed by each member.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamRole"
}],
"strength" : "example",
"description" : "The role codes for the care team members.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-careteamrole"
}
},
{
"id" : "Claim.careTeam.qualification",
"path" : "Claim.careTeam.qualification",
"short" : "Practitioner credential or specialization",
"definition" : "The qualification of the practitioner which is applicable for this service.",
"requirements" : "Need to specify which qualification a provider is delivering the product or service under.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProviderQualification"
}],
"strength" : "example",
"description" : "Provider professional qualifications.",
"valueSet" : "http://hl7.org/fhir/ValueSet/provider-qualification"
}
},
{
"id" : "Claim.supportingInfo",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SupportingInformation"
}],
"path" : "Claim.supportingInfo",
"short" : "Supporting information",
"definition" : "Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.",
"comment" : "Often there are multiple jurisdiction specific valuesets which are required.",
"requirements" : "Typically these information codes are required to support the services rendered or the adjudication of the services rendered.",
"alias" : ["Attachments\nException Codes\nOccurrence Codes\nValue codes"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
}]
},
{
"id" : "Claim.supportingInfo.sequence",
"path" : "Claim.supportingInfo.sequence",
"short" : "Information instance identifier",
"definition" : "A number to uniquely identify supporting information entries.",
"requirements" : "Necessary to maintain the order of the supporting information items and provide a mechanism to link to claim details.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.supportingInfo.category",
"path" : "Claim.supportingInfo.category",
"short" : "Classification of the supplied information",
"definition" : "The general class of the information supplied: information; exception; accident, employment; onset, etc.",
"comment" : "This may contain a category for the local bill type codes.",
"requirements" : "Required to group or associate information items with common characteristics. For example: admission information or prior treatments.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "InformationCategory"
}],
"strength" : "example",
"description" : "The valuset used for additional information category codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-informationcategory"
}
},
{
"id" : "Claim.supportingInfo.code",
"path" : "Claim.supportingInfo.code",
"short" : "Type of information",
"definition" : "System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.",
"requirements" : "Required to identify the kind of additional information.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "InformationCode"
}],
"strength" : "example",
"description" : "The valuset used for additional information codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-exception"
}
},
{
"id" : "Claim.supportingInfo.timing[x]",
"path" : "Claim.supportingInfo.timing[x]",
"short" : "When it occurred",
"definition" : "The date when or period to which this information refers.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
},
{
"id": "Claim.item.detail.subDetail",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "SubDetail"
}
],
"path": "Claim.item.detail.subDetail",
"short": "Additional items",
"definition": "Third tier of goods and services.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
"code" : "Period"
}]
},
{
"id" : "Claim.supportingInfo.value[x]",
"path" : "Claim.supportingInfo.value[x]",
"short" : "Data to be provided",
"definition" : "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.",
"comment" : "Could be used to provide references to other resources, document. For example could contain a PDF in an Attachment of the Police Report for an Accident.",
"requirements" : "To convey the data content to be provided when the information is more than a simple code or period.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
},
{
"id": "Claim.item.detail.subDetail.sequence",
"path": "Claim.item.detail.subDetail.sequence",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
"code" : "string"
},
{
"id": "Claim.item.detail.subDetail.revenue",
"path": "Claim.item.detail.subDetail.revenue",
"short": "Revenue or cost center code",
"definition": "The type of reveneu or cost center providing the product and/or service.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RevenueCenter"
}
],
"strength": "example",
"description": "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
}
"code" : "Quantity"
},
{
"id": "Claim.item.detail.subDetail.category",
"path": "Claim.item.detail.subDetail.category",
"short": "Type of service or product",
"definition": "Health Care Service Type Codes to identify the classification of service or benefits.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BenefitSubCategory"
}
],
"strength": "example",
"description": "Benefit subcategories such as: oral-basic, major, glasses",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/benefit-subcategory"
}
}
"code" : "Attachment"
},
{
"id": "Claim.item.detail.subDetail.service",
"path": "Claim.item.detail.subDetail.service",
"short": "Billing Code",
"definition": "A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceProduct"
}
],
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-uscls"
}
}
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}]
},
{
"id" : "Claim.supportingInfo.reason",
"path" : "Claim.supportingInfo.reason",
"short" : "Explanation for the information",
"definition" : "Provides the reason in the situation where a reason code is required in addition to the content.",
"comment" : "For example: the reason for the additional stay, or why a tooth is missing.",
"requirements" : "Needed when the supporting information has both a date and amount/value and requires explanation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MissingReason"
}],
"strength" : "example",
"description" : "Reason codes for the missing teeth.",
"valueSet" : "http://hl7.org/fhir/ValueSet/missing-tooth-reason"
}
},
{
"id" : "Claim.diagnosis",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Diagnosis"
}],
"path" : "Claim.diagnosis",
"short" : "Pertinent diagnosis information",
"definition" : "Information about diagnoses relevant to the claim items.",
"requirements" : "Required for the adjudication by provided context for the services and product listed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
}]
},
{
"id" : "Claim.diagnosis.sequence",
"path" : "Claim.diagnosis.sequence",
"short" : "Diagnosis instance identifier",
"definition" : "A number to uniquely identify diagnosis entries.",
"comment" : "Diagnosis are presented in list order to their expected importance: primary, secondary, etc.",
"requirements" : "Necessary to maintain the order of the diagnosis items and provide a mechanism to link to claim details.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.diagnosis.diagnosis[x]",
"path" : "Claim.diagnosis.diagnosis[x]",
"short" : "Nature of illness or problem",
"definition" : "The nature of illness or problem in a coded form or as a reference to an external defined Condition.",
"requirements" : "Provides health context for the evaluation of the products and/or services.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"id": "Claim.item.detail.subDetail.modifier",
"path": "Claim.item.detail.subDetail.modifier",
"short": "Service/Product billing modifiers",
"definition": "Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Modifiers"
}
],
"strength": "example",
"description": "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
}
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ICD10"
}],
"strength" : "example",
"description" : "Example ICD10 Diagnostic codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/icd-10"
}
},
{
"id" : "Claim.diagnosis.type",
"path" : "Claim.diagnosis.type",
"short" : "Timing or nature of the diagnosis",
"definition" : "When the condition was observed or the relative ranking.",
"comment" : "For example: admitting, primary, secondary, discharge.",
"requirements" : "Often required to capture a particular diagnosis, for example: primary or discharge.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DiagnosisType"
}],
"strength" : "example",
"description" : "The type of the diagnosis: admitting, principal, discharge.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-diagnosistype"
}
},
{
"id" : "Claim.diagnosis.onAdmission",
"path" : "Claim.diagnosis.onAdmission",
"short" : "Present on admission",
"definition" : "Indication of whether the diagnosis was present on admission to a facility.",
"requirements" : "Many systems need to understand for adjudication if the diagnosis was present a time of admission.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DiagnosisOnAdmission"
}],
"strength" : "example",
"description" : "Present on admission.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-diagnosis-on-admission"
}
},
{
"id" : "Claim.diagnosis.packageCode",
"path" : "Claim.diagnosis.packageCode",
"short" : "Package billing code",
"definition" : "A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.",
"comment" : "For example DRG (Diagnosis Related Group) or a bundled billing code. A patient may have a diagnosis of a Myocardial Infarction and a DRG for HeartAttack would be assigned. The Claim item (and possible subsequent claims) would refer to the DRG for those line items that were for services related to the heart attack event.",
"requirements" : "Required to relate the current diagnosis to a package billing code that is then referenced on the individual claim items which are specific to the health condition covered by the package code.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DiagnosisRelatedGroup"
}],
"strength" : "example",
"description" : "The DRG codes associated with the diagnosis.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-diagnosisrelatedgroup"
}
},
{
"id" : "Claim.procedure",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Procedure"
}],
"path" : "Claim.procedure",
"short" : "Clinical procedures performed",
"definition" : "Procedures performed on the patient relevant to the billing items with the claim.",
"requirements" : "The specific clinical invention are sometimes required to be provided to justify billing a greater than customary amount for a service.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.procedure.sequence",
"path" : "Claim.procedure.sequence",
"short" : "Procedure instance identifier",
"definition" : "A number to uniquely identify procedure entries.",
"requirements" : "Necessary to provide a mechanism to link to claim details.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.procedure.type",
"path" : "Claim.procedure.type",
"short" : "Category of Procedure",
"definition" : "When the condition was observed or the relative ranking.",
"comment" : "For example: primary, secondary.",
"requirements" : "Often required to capture a particular diagnosis, for example: primary or discharge.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureType"
}],
"strength" : "example",
"description" : "Example procedure type codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-procedure-type"
}
},
{
"id" : "Claim.procedure.date",
"path" : "Claim.procedure.date",
"short" : "When the procedure was performed",
"definition" : "Date and optionally time the procedure was performed.",
"requirements" : "Required for auditing purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}]
},
{
"id" : "Claim.procedure.procedure[x]",
"path" : "Claim.procedure.procedure[x]",
"short" : "Specific clinical procedure",
"definition" : "The code or reference to a Procedure resource which identifies the clinical intervention performed.",
"requirements" : "This identifies the actual clinical procedure.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"id": "Claim.item.detail.subDetail.programCode",
"path": "Claim.item.detail.subDetail.programCode",
"short": "Program specific reason for item inclusion",
"definition": "For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ProgramCode"
}
],
"strength": "example",
"description": "Program specific reason codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/ex-program-code"
}
}
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Procedure"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ICD10_Procedures"
}],
"strength" : "example",
"description" : "Example ICD10 Procedure codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/icd-10-procedures"
}
},
{
"id" : "Claim.procedure.udi",
"path" : "Claim.procedure.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}]
},
{
"id" : "Claim.insurance",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Insurance"
}],
"path" : "Claim.insurance",
"short" : "Patient insurance information",
"definition" : "Financial instruments for reimbursement for the health care products and services specified on the claim.",
"comment" : "All insurance coverages for the patient which may be applicable for reimbursement, of the products and services listed in the claim, are typically provided in the claim to allow insurers to confirm the ordering of the insurance coverages relative to local 'coordination of benefit' rules. One coverage (and only one) with 'focal=true' is to be used in the adjudication of this claim. Coverages appearing before the focal Coverage in the list, and where 'Coverage.subrogation=false', should provide a reference to the ClaimResponse containing the adjudication results of the prior claim.",
"requirements" : "At least one insurer is required for a claim to be a claim.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "Coverage"
}]
},
{
"id" : "Claim.insurance.sequence",
"path" : "Claim.insurance.sequence",
"short" : "Insurance instance identifier",
"definition" : "A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.",
"requirements" : "To maintain order of the coverages.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}],
"isSummary" : true
},
{
"id" : "Claim.insurance.focal",
"path" : "Claim.insurance.focal",
"short" : "Coverage to be used for adjudication",
"definition" : "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.",
"comment" : "A patient may (will) have multiple insurance policies which provide reimbursement for healthcare services and products. For example a person may also be covered by their spouse's policy and both appear in the list (and may be from the same insurer). This flag will be set to true for only one of the listed policies and that policy will be used for adjudicating this claim. Other claims would be created to request adjudication against the other listed policies.",
"requirements" : "To identify which coverage in the list is being used to adjudicate this claim.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "Claim.insurance.identifier",
"path" : "Claim.insurance.identifier",
"short" : "Pre-assigned Claim number",
"definition" : "The business identifier to be used when the claim is sent for adjudication against this insurance policy.",
"comment" : "Only required in jurisdictions where insurers, rather than the provider, are required to send claims to insurers that appear after them in the list. This element is not required when 'subrogation=true'.",
"requirements" : "This will be the claim number should it be necessary to create this claim in the future. This is provided so that payors may forward claims to other payors in the Coordination of Benefit for adjudication rather than the provider being required to initiate each adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"id": "Claim.item.detail.subDetail.quantity",
"path": "Claim.item.detail.subDetail.quantity",
"short": "Count of Products or Services",
"definition": "The number of repetitions of a service or product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
]
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Claim.insurance.coverage",
"path" : "Claim.insurance.coverage",
"short" : "Insurance information",
"definition" : "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.",
"requirements" : "Required to allow the adjudicator to locate the correct policy and history within their information system.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage"]
}],
"isSummary" : true
},
{
"id" : "Claim.insurance.businessArrangement",
"path" : "Claim.insurance.businessArrangement",
"short" : "Additional provider contract number",
"definition" : "A business agreement number established between the provider and the insurer for special business processing purposes.",
"requirements" : "Providers may have multiple business arrangements with a given insurer and must supply the specific contract number for adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "Claim.insurance.preAuthRef",
"path" : "Claim.insurance.preAuthRef",
"short" : "Prior authorization reference number",
"definition" : "Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.",
"comment" : "This value is an alphanumeric string that may be provided over the phone, via text, via paper, or within a ClaimResponse resource and is not a FHIR Identifier.",
"requirements" : "Providers must quote previously issued authorization reference numbers in order to obtain adjudication as previously advised on the Preauthorization.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}]
},
{
"id" : "Claim.insurance.claimResponse",
"path" : "Claim.insurance.claimResponse",
"short" : "Adjudication results",
"definition" : "The result of the adjudication of the line items for the Coverage specified in this insurance.",
"comment" : "Must not be specified when 'focal=true' for this insurance.",
"requirements" : "An insurer need the adjudication results from prior insurers to determine the outstanding balance remaining by item for the items in the curent claim.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ClaimResponse"]
}]
},
{
"id" : "Claim.accident",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Accident"
}],
"path" : "Claim.accident",
"short" : "Details of the event",
"definition" : "Details of an accident which resulted in injuries which required the products and services listed in the claim.",
"requirements" : "When healthcare products and services are accident related, benefits may be payable under accident provisions of policies, such as automotive, etc before they are payable under normal health insurance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.accident.date",
"path" : "Claim.accident.date",
"short" : "When the incident occurred",
"definition" : "Date of an accident event related to the products and services contained in the claim.",
"comment" : "The date of the accident has to precede the dates of the products and services but within a reasonable timeframe.",
"requirements" : "Required for audit purposes and adjudication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "date"
}]
},
{
"id" : "Claim.accident.type",
"path" : "Claim.accident.type",
"short" : "The nature of the accident",
"definition" : "The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.",
"requirements" : "Coverage may be dependant on the type of accident.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AccidentType"
}],
"strength" : "extensible",
"description" : "Type of accident: work place, auto, etc.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActIncidentCode"
}
},
{
"id" : "Claim.accident.location[x]",
"path" : "Claim.accident.location[x]",
"short" : "Where the event occurred",
"definition" : "The physical location of the accident event.",
"requirements" : "Required for audit purposes and determination of applicable insurance liability.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Address"
},
{
"id": "Claim.item.detail.subDetail.unitPrice",
"path": "Claim.item.detail.subDetail.unitPrice",
"short": "Fee, charge or cost per point",
"definition": "The fee for an addittional service or product or charge.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}]
},
{
"id" : "Claim.item",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Item"
}],
"path" : "Claim.item",
"short" : "Product or service provided",
"definition" : "A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.",
"requirements" : "The items to be processed for adjudication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.item.sequence",
"path" : "Claim.item.sequence",
"short" : "Item instance identifier",
"definition" : "A number to uniquely identify item entries.",
"requirements" : "Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.careTeamSequence",
"path" : "Claim.item.careTeamSequence",
"short" : "Applicable careTeam members",
"definition" : "CareTeam members related to this service or product.",
"requirements" : "Need to identify the individuals and their roles in the provision of the product or service.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.diagnosisSequence",
"path" : "Claim.item.diagnosisSequence",
"short" : "Applicable diagnoses",
"definition" : "Diagnosis applicable for this service or product.",
"requirements" : "Need to related the product or service to the associated diagnoses.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.procedureSequence",
"path" : "Claim.item.procedureSequence",
"short" : "Applicable procedures",
"definition" : "Procedures applicable for this service or product.",
"requirements" : "Need to provide any listed specific procedures to support the product or service being claimed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.informationSequence",
"path" : "Claim.item.informationSequence",
"short" : "Applicable exception and supporting information",
"definition" : "Exceptions, special conditions and supporting information applicable for this service or product.",
"requirements" : "Need to reference the supporting information items that relate directly to this product or service.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.revenue",
"path" : "Claim.item.revenue",
"short" : "Revenue or cost center code",
"definition" : "The type of revenue or cost center providing the product and/or service.",
"requirements" : "Needed in the processing of institutional claims.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RevenueCenter"
}],
"strength" : "example",
"description" : "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
},
{
"id" : "Claim.item.category",
"path" : "Claim.item.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral-basic, major, glasses.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "Claim.item.productOrService",
"path" : "Claim.item.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"alias" : ["Drug Code",
"Bill Code",
"Service Code"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "Claim.item.modifier",
"path" : "Claim.item.modifier",
"short" : "Product or service billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or outside of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "Claim.item.programCode",
"path" : "Claim.item.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
}
},
{
"id" : "Claim.item.serviced[x]",
"path" : "Claim.item.serviced[x]",
"short" : "Date or dates of service or product delivery",
"definition" : "The date or dates when the service or product was supplied, performed or completed.",
"requirements" : "Needed to determine whether the service or product was provided during the term of the insurance coverage.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
},
{
"id": "Claim.item.detail.subDetail.factor",
"path": "Claim.item.detail.subDetail.factor",
"short": "Price scaling factor",
"definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
"code" : "Period"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Claim.item.location[x]",
"path" : "Claim.item.location[x]",
"short" : "Place of service or where product was supplied",
"definition" : "Where the product or service was provided.",
"requirements" : "The location can alter whether the item was acceptable for insurance purposes or impact the determination of the benefit amount.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"id": "Claim.item.detail.subDetail.net",
"path": "Claim.item.detail.subDetail.net",
"short": "Net additional item cost",
"definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"code" : "Address"
},
{
"id": "Claim.item.detail.subDetail.udi",
"path": "Claim.item.detail.subDetail.udi",
"short": "Unique Device Identifier",
"definition": "List of Unique Device Identifiers associated with this line item.",
"requirements": "The UDI code and issuer if applicable for the supplied product.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
]
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServicePlace"
}],
"strength" : "example",
"description" : "Place of service: pharmacy, school, prison, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-place"
},
{
"id": "Claim.total",
"path": "Claim.total",
"short": "Total claim cost",
"definition": "The total value of the claim.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
}]
},
{
"id" : "Claim.item.quantity",
"path" : "Claim.item.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}]
},
{
"id" : "Claim.item.unitPrice",
"path" : "Claim.item.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "Claim.item.factor",
"path" : "Claim.item.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "Claim.item.net",
"path" : "Claim.item.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "Claim.item.udi",
"path" : "Claim.item.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}]
},
{
"id" : "Claim.item.bodySite",
"path" : "Claim.item.bodySite",
"short" : "Anatomical location",
"definition" : "Physical service site on the patient (limb, tooth, etc.).",
"comment" : "For example: Providing a tooth code, allows an insurer to identify a provider performing a filling on a tooth that was previously removed.",
"requirements" : "Allows insurer to validate specific procedures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OralSites"
}],
"strength" : "example",
"description" : "The code for the teeth, quadrant, sextant and arch.",
"valueSet" : "http://hl7.org/fhir/ValueSet/tooth"
}
]
},
{
"id" : "Claim.item.subSite",
"path" : "Claim.item.subSite",
"short" : "Anatomical sub-location",
"definition" : "A region or surface of the bodySite, e.g. limb region or tooth surface(s).",
"requirements" : "Allows insurer to validate specific procedures.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Surface"
}],
"strength" : "example",
"description" : "The code for the tooth surface and surface combinations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/surface"
}
},
{
"id" : "Claim.item.encounter",
"path" : "Claim.item.encounter",
"short" : "Encounters related to this billed item",
"definition" : "The Encounters during which this Claim was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"requirements" : "Used in some jurisdictions to link clinical events to claim items.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context"
}]
},
{
"id" : "Claim.item.detail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Detail"
}],
"path" : "Claim.item.detail",
"short" : "Product or service provided",
"definition" : "A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.",
"requirements" : "The items to be processed for adjudication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.item.detail.sequence",
"path" : "Claim.item.detail.sequence",
"short" : "Item instance identifier",
"definition" : "A number to uniquely identify item entries.",
"requirements" : "Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.detail.revenue",
"path" : "Claim.item.detail.revenue",
"short" : "Revenue or cost center code",
"definition" : "The type of revenue or cost center providing the product and/or service.",
"requirements" : "Needed in the processing of institutional claims.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RevenueCenter"
}],
"strength" : "example",
"description" : "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
},
{
"id" : "Claim.item.detail.category",
"path" : "Claim.item.detail.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral-basic, major, glasses.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "Claim.item.detail.productOrService",
"path" : "Claim.item.detail.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"alias" : ["Drug Code",
"Bill Code",
"Service Code"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "Claim.item.detail.modifier",
"path" : "Claim.item.detail.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "Claim.item.detail.programCode",
"path" : "Claim.item.detail.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
}
},
{
"id" : "Claim.item.detail.quantity",
"path" : "Claim.item.detail.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}]
},
{
"id" : "Claim.item.detail.unitPrice",
"path" : "Claim.item.detail.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "Claim.item.detail.factor",
"path" : "Claim.item.detail.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "Claim.item.detail.net",
"path" : "Claim.item.detail.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "Claim.item.detail.udi",
"path" : "Claim.item.detail.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}]
},
{
"id" : "Claim.item.detail.subDetail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SubDetail"
}],
"path" : "Claim.item.detail.subDetail",
"short" : "Product or service provided",
"definition" : "A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.",
"requirements" : "The items to be processed for adjudication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "Claim.item.detail.subDetail.sequence",
"path" : "Claim.item.detail.subDetail.sequence",
"short" : "Item instance identifier",
"definition" : "A number to uniquely identify item entries.",
"requirements" : "Necessary to provide a mechanism to link to items from within the claim and within the adjudication details of the ClaimResponse.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}]
},
{
"id" : "Claim.item.detail.subDetail.revenue",
"path" : "Claim.item.detail.subDetail.revenue",
"short" : "Revenue or cost center code",
"definition" : "The type of revenue or cost center providing the product and/or service.",
"requirements" : "Needed in the processing of institutional claims.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RevenueCenter"
}],
"strength" : "example",
"description" : "Codes for the revenue or cost centers supplying the service and/or products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-revenue-center"
}
},
{
"id" : "Claim.item.detail.subDetail.category",
"path" : "Claim.item.detail.subDetail.category",
"short" : "Benefit classification",
"definition" : "Code to identify the general type of benefits under which products and services are provided.",
"comment" : "Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.",
"requirements" : "Needed in the processing of institutional claims as this allows the insurer to determine whether a facial X-Ray is for dental, orthopedic, or facial surgery purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BenefitCategory"
}],
"strength" : "example",
"description" : "Benefit categories such as: oral-basic, major, glasses.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-benefitcategory"
}
},
{
"id" : "Claim.item.detail.subDetail.productOrService",
"path" : "Claim.item.detail.subDetail.productOrService",
"short" : "Billing, service, product, or drug code",
"definition" : "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.",
"comment" : "If this is an actual service or product line, i.e. not a Group, then use code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS, USCLS, ICD10, NCPDP, DIN, RxNorm, ACHI, CCI). If a grouping item then use a group code to indicate the type of thing being grouped e.g. 'glasses' or 'compound'.",
"requirements" : "Necessary to state what was provided or done.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceProduct"
}],
"strength" : "example",
"description" : "Allowable service and product codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-uscls"
}
},
{
"id" : "Claim.item.detail.subDetail.modifier",
"path" : "Claim.item.detail.subDetail.modifier",
"short" : "Service/Product billing modifiers",
"definition" : "Item typification or modifiers codes to convey additional context for the product or service.",
"comment" : "For example in Oral whether the treatment is cosmetic or associated with TMJ, or for Medical whether the treatment was outside the clinic or out of office hours.",
"requirements" : "To support inclusion of the item for adjudication or to charge an elevated fee.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Modifiers"
}],
"strength" : "example",
"description" : "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/claim-modifiers"
}
},
{
"id" : "Claim.item.detail.subDetail.programCode",
"path" : "Claim.item.detail.subDetail.programCode",
"short" : "Program the product or service is provided under",
"definition" : "Identifies the program under which this may be recovered.",
"comment" : "For example: Neonatal program, child dental program or drug users recovery program.",
"requirements" : "Commonly used in in the identification of publicly provided program focused on population segments or disease classifications.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProgramCode"
}],
"strength" : "example",
"description" : "Program specific reason codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ex-program-code"
}
},
{
"id" : "Claim.item.detail.subDetail.quantity",
"path" : "Claim.item.detail.subDetail.quantity",
"short" : "Count of products or services",
"definition" : "The number of repetitions of a service or product.",
"requirements" : "Required when the product or service code does not convey the quantity provided.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}]
},
{
"id" : "Claim.item.detail.subDetail.unitPrice",
"path" : "Claim.item.detail.subDetail.unitPrice",
"short" : "Fee, charge or cost per item",
"definition" : "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.",
"requirements" : "The amount charged to the patient by the provider for a single unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "Claim.item.detail.subDetail.factor",
"path" : "Claim.item.detail.subDetail.factor",
"short" : "Price scaling factor",
"definition" : "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"comment" : "To show a 10% senior's discount, the value entered is: 0.90 (1.00 - 0.10).",
"requirements" : "When discounts are provided to a patient (example: Senior's discount) then this must be documented for adjudication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "Claim.item.detail.subDetail.net",
"path" : "Claim.item.detail.subDetail.net",
"short" : "Total item cost",
"definition" : "The quantity times the unit price for an additional service or product or charge.",
"comment" : "For example, the formula: quantity * unitPrice * factor = net. Quantity and factor are assumed to be 1 if not supplied.",
"requirements" : "Provides the total amount claimed for the group (if a grouper) or the line item.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "Claim.item.detail.subDetail.udi",
"path" : "Claim.item.detail.subDetail.udi",
"short" : "Unique device identifier",
"definition" : "Unique Device Identifiers associated with this line item.",
"requirements" : "The UDI code allows the insurer to obtain device level information on the product supplied.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}]
},
{
"id" : "Claim.total",
"path" : "Claim.total",
"short" : "Total claim cost",
"definition" : "The total value of the all the items in the claim.",
"requirements" : "Used for control total purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
}]
}
}
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
Release
3
(STU;
v3.0.2-11200)
4
(Technical
Correction
#1)
(v4.0.1)
generated
on
Thurs,
Oct
24,
Fri,
Nov
1,
2019
11:53+1100.
09:34+1100.
QA
Page
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
|
Compare
to
DSTU2
R3
|
|
Propose
a
change