2nd DSTU Draft For Comment

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

7.19 Resource SupportingDocumentation - Content

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.

7.19.1 Scope and Usage

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

This resource is referenced by [Reversal]

7.19.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. SupportingDocumentation DomainResourceDocumentation submission
... identifier 1..*IdentifierBusiness Identifier
... ruleset 0..1CodingResource version
Ruleset (Example)
... originalRuleset 0..1CodingOriginal version
Ruleset (Example)
... created 0..1dateTimeCreation date
... target 0..1Organization | PractitionerInsurer or Provider
... provider 0..1PractitionerResponsible practitioner
... organization 0..1OrganizationResponsible organization
... request 0..1AnyRequest reference
... response 0..1AnyResponse reference
... author 0..1PractitionerAuthor
... subject 0..1PatientPatient
... detail 0..*ElementSupporting Files
.... linkId 1..1integerLinkId
.... content[x] Content
..... contentReference1..1Any
..... contentAttachment1..1Attachment
.... dateTime 0..1dateTimeCreation date and time

UML Diagram

SupportingDocumentation (DomainResource)The Response Business Identifieridentifier : Identifier 1..*The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resourcesruleset : Coding 0..1 « (The static and dynamic model to which contents conform, may be business version or standard and version.Ruleset) »The style (standard) and version of the original material which was converted into this resourceoriginalRuleset : Coding 0..1 « (The static and dynamic model to which contents conform, may be business version or standard and version.Ruleset) »The date when this resource was createdcreated : dateTime 0..1The Insurer, organization or Provider who is target of the submissiontarget : Reference(Organization|Practitioner) 0..1The practitioner who is responsible for the services rendered to the patientprovider : Reference(Practitioner) 0..1The organization which is responsible for the services rendered to the patientorganization : Reference(Organization) 0..1Original requestrequest : Reference(Any) 0..1Original responseresponse : Reference(Any) 0..1Person who created the submissionauthor : Reference(Practitioner) 0..1The patient who is directly or indirectly the subject of the supporting informationsubject : Reference(Patient) 0..1DetailA link Id for the response to referencelinkId : integer 1..1The attached contentcontent[x] : Reference(Any)|Attachment 1..1The date and optionally time when the material was createddateTime : dateTime 0..1Supporting Filesdetail0..*

XML Template

<SupportingDocumentation xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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

NameFlagsCard.TypeDescription & Constraintsdoco
.. SupportingDocumentation DomainResourceDocumentation submission
... identifier 1..*IdentifierBusiness Identifier
... ruleset 0..1CodingResource version
Ruleset (Example)
... originalRuleset 0..1CodingOriginal version
Ruleset (Example)
... created 0..1dateTimeCreation date
... target 0..1Organization | PractitionerInsurer or Provider
... provider 0..1PractitionerResponsible practitioner
... organization 0..1OrganizationResponsible organization
... request 0..1AnyRequest reference
... response 0..1AnyResponse reference
... author 0..1PractitionerAuthor
... subject 0..1PatientPatient
... detail 0..*ElementSupporting Files
.... linkId 1..1integerLinkId
.... content[x] Content
..... contentReference1..1Any
..... contentAttachment1..1Attachment
.... dateTime 0..1dateTimeCreation date and time

UML Diagram

SupportingDocumentation (DomainResource)The Response Business Identifieridentifier : Identifier 1..*The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resourcesruleset : Coding 0..1 « (The static and dynamic model to which contents conform, may be business version or standard and version.Ruleset) »The style (standard) and version of the original material which was converted into this resourceoriginalRuleset : Coding 0..1 « (The static and dynamic model to which contents conform, may be business version or standard and version.Ruleset) »The date when this resource was createdcreated : dateTime 0..1The Insurer, organization or Provider who is target of the submissiontarget : Reference(Organization|Practitioner) 0..1The practitioner who is responsible for the services rendered to the patientprovider : Reference(Practitioner) 0..1The organization which is responsible for the services rendered to the patientorganization : Reference(Organization) 0..1Original requestrequest : Reference(Any) 0..1Original responseresponse : Reference(Any) 0..1Person who created the submissionauthor : Reference(Practitioner) 0..1The patient who is directly or indirectly the subject of the supporting informationsubject : Reference(Patient) 0..1DetailA link Id for the response to referencelinkId : integer 1..1The attached contentcontent[x] : Reference(Any)|Attachment 1..1The date and optionally time when the material was createddateTime : dateTime 0..1Supporting Filesdetail0..*

XML Template

<SupportingDocumentation xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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

7.19.2.1 Terminology Bindings

PathDefinitionTypeReference
SupportingDocumentation.ruleset
SupportingDocumentation.originalRuleset 		The static and dynamic model to which contents conform, may be business version or standard and version.Examplehttp://hl7.org/fhir/vs/ruleset

7.19.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
authorreferenceThe person who generated this resourceSupportingDocumentation.author
(Practitioner)
identifiertokenThe business identifier of the EligibilitySupportingDocumentation.identifier
patientreferenceThe patient to whom the documents referSupportingDocumentation.subject
(Patient)
subjectreferenceThe patient to whom the documents referSupportingDocumentation.subject
(Patient)