This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Coverage.questionnaire.json

Raw JSON (canonical form)

Generated Questionnaire for Coverage

{
  "resourceType": "Questionnaire",
  "id": "qs1",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986"
    }
  ],
  "status": "draft",
  "date": "2015-03-27T00:13:00+11:00",
  "publisher": "HL7 FHIR Project (Financial Management)",
  "group": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
        "valueString": "Financial instrument which may be used to pay for or reimburse for health care products and services."
      }
    ],
    "linkId": "Coverage",
    "title": "Insurance or medical plan",
    "required": true,
    "repeats": false,
    "group": [
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "Coverage.id",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.id.value",
            "text": "Logical id of this artefact",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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."
          }
        ],
        "linkId": "Coverage.meta",
        "text": "Metadata about the resource",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "uri"
          }
        ],
        "linkId": "Coverage.implicitRules",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.implicitRules.value",
            "text": "A set of rules under which this content was created",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource\n\nNot all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "code"
          }
        ],
        "linkId": "Coverage.language",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.language.value",
            "text": "language",
            "type": "choice",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
          }
        ],
        "linkId": "Coverage.text",
        "text": "Text summary of the resource, for human interpretation",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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. 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."
          }
        ],
        "linkId": "Coverage.contained",
        "text": "Contained, inline Resources",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The program or plan underwriter or payor."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Reference"
          }
        ],
        "linkId": "Coverage.issuer",
        "required": false,
        "repeats": true,
        "question": [
          {
            "extension": [
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                "valueString": "/Organization?subject=$subj&patient=$subj&encounter=$encounter"
              }
            ],
            "linkId": "Coverage.issuer.value",
            "text": "An identifier for the plan issuer",
            "type": "reference",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Business Identification Number (BIN number) used to identify the routing  of eclaims if the insurer themselves don't have a BIN number for all of their business."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Identifier"
          }
        ],
        "linkId": "Coverage.bin",
        "text": "BIN Number",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.bin.label",
            "text": "label:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Coverage.bin.system",
            "text": "system:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Coverage.bin.value",
            "text": "value:",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Period"
          }
        ],
        "linkId": "Coverage.period",
        "text": "Coverage start and end dates",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.period.low",
            "text": "start:",
            "type": "dateTime",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Coverage.period.end",
            "text": "end:",
            "type": "dateTime",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Coding"
          }
        ],
        "linkId": "Coverage.type",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.type.value",
            "text": "Type of coverage",
            "type": "open-choice",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The id issued to the subscriber."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Identifier"
          }
        ],
        "linkId": "Coverage.subscriberId",
        "text": "Subscriber ID",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.subscriberId.label",
            "text": "label:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Coverage.subscriberId.system",
            "text": "system:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Coverage.subscriberId.value",
            "text": "value:",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Subscriber Id, Certificate number or Personal Health Number or Case ID."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Identifier"
          }
        ],
        "linkId": "Coverage.identifier",
        "text": "The primary coverage ID",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.identifier.label",
            "text": "label:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Coverage.identifier.system",
            "text": "system:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Coverage.identifier.value",
            "text": "value:",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "Coverage.group",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.group.value",
            "text": "An identifier for the group",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "Coverage.plan",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.plan.value",
            "text": "An identifier for the plan",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a specific employer group within a class of employers. May be referred to as a Section or Division ID."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "Coverage.subPlan",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.subPlan.value",
            "text": "An identifier for the subsection of the plan",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A unique identifier for a dependent under the coverage."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "integer"
          }
        ],
        "linkId": "Coverage.dependent",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.dependent.value",
            "text": "The dependent number",
            "type": "integer",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "An optional counter for a particular instance of the identified coverage which increments upon each renewal."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "integer"
          }
        ],
        "linkId": "Coverage.sequence",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.sequence.value",
            "text": "The plan instance or sequence counter",
            "type": "integer",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Reference"
          }
        ],
        "linkId": "Coverage.subscriber",
        "required": false,
        "repeats": true,
        "question": [
          {
            "extension": [
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                "valueString": "/Patient?subject=$subj&patient=$subj&encounter=$encounter"
              }
            ],
            "linkId": "Coverage.subscriber.value",
            "text": "Plan holder information",
            "type": "reference",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The identifier for a community of providers."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Identifier"
          }
        ],
        "linkId": "Coverage.network",
        "text": "Insurer network",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Coverage.network.label",
            "text": "label:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Coverage.network.system",
            "text": "system:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Coverage.network.value",
            "text": "value:",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The policy(s) which constitute this insurance coverage."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Reference"
          }
        ],
        "linkId": "Coverage.contract",
        "required": false,
        "repeats": true,
        "question": [
          {
            "extension": [
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                "valueString": "/Contract?subject=$subj&patient=$subj&encounter=$encounter"
              }
            ],
            "linkId": "Coverage.contract.value",
            "text": "Contract details",
            "type": "reference",
            "required": false,
            "repeats": false
          }
        ]
      }
    ]
  }
}

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.