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
This resource maintained by the Financial Management Work Group
This resource provides the supporting information for a process, for example clinical or financial information related to a claim or pre-authorization.
The SupportingDocumentation resource supplies a suite of supporting information for an identified business purpose, such as a Claim or other financial process, where the supporting information is provided as content or references to external locations.
This is the submission of information, (images, xrays, documents, reports) in support of a submitted processing request or information exchange. The information may be actually contained within or referred to some other location by the SupportingDocumentation resource.
Todo
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SupportingDocumentation | DomainResource | Documentation submission | ||
identifier | 1..* | Identifier | Business Identifier | |
ruleset | 0..1 | Coding | Resource version Ruleset (Example) | |
originalRuleset | 0..1 | Coding | Original version Ruleset (Example) | |
created | 0..1 | dateTime | Creation date | |
target | 0..1 | Organization | Practitioner | Insurer or Provider | |
provider | 0..1 | Practitioner | Responsible practitioner | |
organization | 0..1 | Organization | Responsible organization | |
request | 0..1 | Any | Request reference | |
response | 0..1 | Any | Response reference | |
author | 0..1 | Practitioner | Author | |
subject | 0..1 | Patient | Patient | |
detail | 0..* | Element | Supporting Files | |
linkId | 1..1 | integer | LinkId | |
content[x] | Content | |||
contentReference | 1..1 | Any | ||
contentAttachment | 1..1 | Attachment | ||
dateTime | 0..1 | dateTime | Creation date and time |
UML Diagram
XML Template
<SupportingDocumentation xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 1..* Identifier Business Identifier --></identifier> <ruleset><!-- 0..1 Coding Resource version --></ruleset> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <target><!-- 0..1 Reference(Organization|Practitioner) Insurer or Provider --></target> <provider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></provider> <organization><!-- 0..1 Reference(Organization) Responsible organization --></organization> <request><!-- 0..1 Reference(Any) Request reference --></request> <response><!-- 0..1 Reference(Any) Response reference --></response> <author><!-- 0..1 Reference(Practitioner) Author --></author> <subject><!-- 0..1 Reference(Patient) Patient --></subject> <detail> <!-- 0..* Supporting Files --> <linkId value="[integer]"/><!-- 1..1 LinkId --> <content[x]><!-- 1..1 Reference(Any)|Attachment Content --></content[x]> <dateTime value="[dateTime]"/><!-- 0..1 Creation date and time --> </detail> </SupportingDocumentation>
JSON Template
{ "resourceType" : "SupportingDocumentation", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // R! Business Identifier "ruleset" : { Coding }, // Resource version "originalRuleset" : { Coding }, // Original version "created" : "<dateTime>", // Creation date "target" : { Reference(Organization|Practitioner) }, // Insurer or Provider "provider" : { Reference(Practitioner) }, // Responsible practitioner "organization" : { Reference(Organization) }, // Responsible organization "request" : { Reference(Any) }, // Request reference "response" : { Reference(Any) }, // Response reference "author" : { Reference(Practitioner) }, // Author "subject" : { Reference(Patient) }, // Patient "detail" : [{ // Supporting Files "linkId" : <integer>, // R! LinkId // content[x]: Content. One of these 2: "contentReference" : { Reference(Any) }, "contentAttachment" : { Attachment }, "dateTime" : "<dateTime>" // Creation date and time }] }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SupportingDocumentation | DomainResource | Documentation submission | ||
identifier | 1..* | Identifier | Business Identifier | |
ruleset | 0..1 | Coding | Resource version Ruleset (Example) | |
originalRuleset | 0..1 | Coding | Original version Ruleset (Example) | |
created | 0..1 | dateTime | Creation date | |
target | 0..1 | Organization | Practitioner | Insurer or Provider | |
provider | 0..1 | Practitioner | Responsible practitioner | |
organization | 0..1 | Organization | Responsible organization | |
request | 0..1 | Any | Request reference | |
response | 0..1 | Any | Response reference | |
author | 0..1 | Practitioner | Author | |
subject | 0..1 | Patient | Patient | |
detail | 0..* | Element | Supporting Files | |
linkId | 1..1 | integer | LinkId | |
content[x] | Content | |||
contentReference | 1..1 | Any | ||
contentAttachment | 1..1 | Attachment | ||
dateTime | 0..1 | dateTime | Creation date and time |
XML Template
<SupportingDocumentation xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 1..* Identifier Business Identifier --></identifier> <ruleset><!-- 0..1 Coding Resource version --></ruleset> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <target><!-- 0..1 Reference(Organization|Practitioner) Insurer or Provider --></target> <provider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></provider> <organization><!-- 0..1 Reference(Organization) Responsible organization --></organization> <request><!-- 0..1 Reference(Any) Request reference --></request> <response><!-- 0..1 Reference(Any) Response reference --></response> <author><!-- 0..1 Reference(Practitioner) Author --></author> <subject><!-- 0..1 Reference(Patient) Patient --></subject> <detail> <!-- 0..* Supporting Files --> <linkId value="[integer]"/><!-- 1..1 LinkId --> <content[x]><!-- 1..1 Reference(Any)|Attachment Content --></content[x]> <dateTime value="[dateTime]"/><!-- 0..1 Creation date and time --> </detail> </SupportingDocumentation>
JSON Template
{ "resourceType" : "SupportingDocumentation", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // R! Business Identifier "ruleset" : { Coding }, // Resource version "originalRuleset" : { Coding }, // Original version "created" : "<dateTime>", // Creation date "target" : { Reference(Organization|Practitioner) }, // Insurer or Provider "provider" : { Reference(Practitioner) }, // Responsible practitioner "organization" : { Reference(Organization) }, // Responsible organization "request" : { Reference(Any) }, // Request reference "response" : { Reference(Any) }, // Response reference "author" : { Reference(Practitioner) }, // Author "subject" : { Reference(Patient) }, // Patient "detail" : [{ // Supporting Files "linkId" : <integer>, // R! LinkId // content[x]: Content. One of these 2: "contentReference" : { Reference(Any) }, "contentAttachment" : { Attachment }, "dateTime" : "<dateTime>" // Creation date and time }] }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire
Path | Definition | Type | Reference |
---|---|---|---|
SupportingDocumentation.ruleset SupportingDocumentation.originalRuleset | The static and dynamic model to which contents conform, may be business version or standard and version. | Example | http://hl7.org/fhir/vs/ruleset |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
author | reference | The person who generated this resource | SupportingDocumentation.author (Practitioner) |
identifier | token | The business identifier of the Eligibility | SupportingDocumentation.identifier |
patient | reference | The patient to whom the documents refer | SupportingDocumentation.subject (Patient) |
subject | reference | The patient to whom the documents refer | SupportingDocumentation.subject (Patient) |