Current section
Files
Jump to
Current section
Files
priv/schema/Coverage.schema.json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://hl7.erp.uno/priv/schema/Coverage.schema.json",
"$ref": "#/definitions/Coverage",
"description": "see https://hl7.org/fhir/R5/json.html for information about the FHIR Json Schemas",
"definitions": {
"Coverage": {
"allOf": [
{
"$ref": "DomainResource.schema.json#/definitions/DomainResource"
},
{
"description": "Financial instrument which may be used to reimburse or pay for health care products and services.",
"properties": {
"resourceType": {
"description": "This is a Coverage resource",
"type": "string",
"enum": ["Coverage"]
},
"identifier": {
"description": "The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatination of the Coverage.SubscriberID and the Coverage.dependant.",
"type": "array",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
}
},
"status": {
"description": "The status of the resource instance.",
"type": "string",
"pattern": "[^\\s]+([\\s]?[^\\s]+)*"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"policyHolder": {
"description": "The party who \u0027owns\u0027 the insurance policy, may be an individual, corporation or the subscriber\u0027s employer.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"subscriber": {
"description": "The party who has signed-up for or \u0027owns\u0027 the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"subscriberId": {
"description": "The insurer assigned ID for the Subscriber.",
"type": "string"
},
"_subscriberId": {
"description": "Extensions for subscriberId",
"$ref": "Element.schema.json#/definitions/Element"
},
"beneficiary": {
"description": "The party who benefits from the insurance coverage., the patient when services are provided.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"relationship": {
"description": "The relationship of beneficiary (patient) to the subscriber.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"period": {
"description": "Time period during which the coverage is in force. A missing start date indicates the start date isn\u0027t known, a missing end date means the coverage is continuing to be in force.",
"$ref": "Period.schema.json#/definitions/Period"
},
"payor": {
"description": "The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).",
"type": "array",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"grouping": {
"description": "A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan.",
"$ref": "#/definitions/Coverage_Grouping"
},
"dependent": {
"description": "A unique identifier for a dependent under the coverage.",
"type": "string"
},
"_dependent": {
"description": "Extensions for dependent",
"$ref": "Element.schema.json#/definitions/Element"
},
"sequence": {
"description": "An optional counter for a particular instance of the identified coverage which increments upon each renewal.",
"type": "string"
},
"_sequence": {
"description": "Extensions for sequence",
"$ref": "Element.schema.json#/definitions/Element"
},
"order": {
"description": "The order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.",
"type": "number",
"pattern": "[1-9][0-9]*"
},
"_order": {
"description": "Extensions for order",
"$ref": "Element.schema.json#/definitions/Element"
},
"network": {
"description": "The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the \u0027in-network\u0027 rate, otherwise \u0027out of network\u0027 terms and conditions apply.",
"type": "string"
},
"_network": {
"description": "Extensions for network",
"$ref": "Element.schema.json#/definitions/Element"
},
"contract": {
"description": "The policy(s) which constitute this insurance coverage.",
"type": "array",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
}
}
},
"required": ["resourceType"]
}
]
},
"Coverage_Grouping": {
"allOf": [
{
"$ref": "BackboneElement.schema.json#/definitions/BackboneElement"
},
{
"description": "Financial instrument which may be used to reimburse or pay for health care products and services.",
"properties": {
"group": {
"description": "Identifies a style or collective of coverage issued by the underwriter, for example may be used to identify an employer group. May also be referred to as a Policy or Group ID.",
"type": "string"
},
"_group": {
"description": "Extensions for group",
"$ref": "Element.schema.json#/definitions/Element"
},
"groupDisplay": {
"description": "A short description for the group.",
"type": "string"
},
"_groupDisplay": {
"description": "Extensions for groupDisplay",
"$ref": "Element.schema.json#/definitions/Element"
},
"subGroup": {
"description": "Identifies a style or collective of coverage issued by the underwriter, for example may be used to identify a subset of an employer group.",
"type": "string"
},
"_subGroup": {
"description": "Extensions for subGroup",
"$ref": "Element.schema.json#/definitions/Element"
},
"subGroupDisplay": {
"description": "A short description for the subgroup.",
"type": "string"
},
"_subGroupDisplay": {
"description": "Extensions for subGroupDisplay",
"$ref": "Element.schema.json#/definitions/Element"
},
"plan": {
"description": "Identifies a style or collective of coverage issued by the underwriter, for example may be used to identify a collection of benefits provided to employees. May be referred to as a Section or Division ID.",
"type": "string"
},
"_plan": {
"description": "Extensions for plan",
"$ref": "Element.schema.json#/definitions/Element"
},
"planDisplay": {
"description": "A short description for the plan.",
"type": "string"
},
"_planDisplay": {
"description": "Extensions for planDisplay",
"$ref": "Element.schema.json#/definitions/Element"
},
"subPlan": {
"description": "Identifies a sub-style or sub-collective of coverage issued by the underwriter, for example may be used to identify a subset of a collection of benefits provided to employees.",
"type": "string"
},
"_subPlan": {
"description": "Extensions for subPlan",
"$ref": "Element.schema.json#/definitions/Element"
},
"subPlanDisplay": {
"description": "A short description for the subplan.",
"type": "string"
},
"_subPlanDisplay": {
"description": "Extensions for subPlanDisplay",
"$ref": "Element.schema.json#/definitions/Element"
},
"class": {
"description": "Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage such as a level of deductables or co-payment.",
"type": "string"
},
"_class": {
"description": "Extensions for class",
"$ref": "Element.schema.json#/definitions/Element"
},
"classDisplay": {
"description": "A short description for the class.",
"type": "string"
},
"_classDisplay": {
"description": "Extensions for classDisplay",
"$ref": "Element.schema.json#/definitions/Element"
},
"subClass": {
"description": "Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a subclass of coverage such as a sub-level of deductables or co-payment.",
"type": "string"
},
"_subClass": {
"description": "Extensions for subClass",
"$ref": "Element.schema.json#/definitions/Element"
},
"subClassDisplay": {
"description": "A short description for the subclass.",
"type": "string"
},
"_subClassDisplay": {
"description": "Extensions for subClassDisplay",
"$ref": "Element.schema.json#/definitions/Element"
}
}
}
]
}
}
}