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.18 Resource StatusResponse - Content

This resource maintained by the Financial Management Work Group

This resource provides processing status, errors and notes from the processing of a resource.

7.18.1 Scope and Usage

The StatusResponse resource indicates the resource for which the processing status is requested and provides simple acknowledgement and status information of application level errors. It may also be used to convey additional processing requirements in a text form.

This is the formal response to a StatusRequest and may be used as a application level response to PendedRequest, PaymentNotice and SupportingDocumentation resources.

Todo

This resource is referenced by [Reversal]

7.18.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. StatusResponse DomainResourceStatusResponse resource
... identifier 0..*IdentifierBusiness Identifier
... request 0..1AnyRequest reference
... outcome 0..1CodingProcessing outcome
ProcessingOutcome (Example)
... disposition 0..1stringDisposition Message
... ruleset 0..1CodingResource version
Ruleset (Example)
... originalRuleset 0..1CodingOriginal version
Ruleset (Example)
... created 0..1dateTimeCreation date
... organization 0..1OrganizationInsurer
... requestProvider 0..1PractitionerResponsible practitioner
... requestOrganization 0..1OrganizationResponsible organization
... form 0..1CodingPrinted Form Identifier
Forms (Incomplete)
... notes 0..*ElementNotes
.... type 0..1Codingdisplay | print | printoper
NoteType (Incomplete)
.... text 0..1stringNotes text
... error 0..*CodingError code
AdjudicationError (Incomplete)

UML Diagram

StatusResponse (DomainResource)The Response Business Identifieridentifier : Identifier 0..*Original request resource referencerequest : Reference(Any) 0..1Transaction status: error, complete, heldoutcome : Coding 0..1 « (Local status of outcome codesProcessingOutcome) »A description of the status of the adjudication or processingdisposition : string 0..1The 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 the enclosed suite of services were performed or completedcreated : dateTime 0..1The Insurer who produced this adjudicated responseorganization : Reference(Organization) 0..1The practitioner who is responsible for the services rendered to the patientrequestProvider : Reference(Practitioner) 0..1The organization which is responsible for the services rendered to the patientrequestOrganization : Reference(Organization) 0..1The form to be used for printing the contentform : Coding 0..1 « The forms codesForms+ »Processing errorserror : Coding 0..* « The error codes for adjudication processingAdjudicationError+ »NotesThe note purpose: Print/Displaytype : Coding 0..1 « The presentation types of notesNoteType+ »The note texttext : string 0..1Suite of processing note or additional requirements is the processing has been heldnotes0..*

XML Template

<StatusResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <request><!-- 0..1 Reference(Any) Request reference --></request>
 <outcome><!-- 0..1 Coding Processing outcome --></outcome>
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <organization><!-- 0..1 Reference(Organization) Insurer --></organization>
 <requestProvider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
 <form><!-- 0..1 Coding Printed Form Identifier --></form>
 <notes>  <!-- 0..* Notes -->
  <type><!-- 0..1 Coding display | print | printoper --></type>
  <text value="[string]"/><!-- 0..1 Notes text -->
 </notes>
 <error><!-- 0..* Coding Error code --></error>
</StatusResponse>

JSON Template

{doco
  "resourceType" : "StatusResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "request" : { Reference(Any) }, // Request reference
  "outcome" : { Coding }, // Processing outcome
  "disposition" : "<string>", // Disposition Message
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  "organization" : { Reference(Organization) }, // Insurer
  "requestProvider" : { Reference(Practitioner) }, // Responsible practitioner
  "requestOrganization" : { Reference(Organization) }, // Responsible organization
  "form" : { Coding }, // Printed Form Identifier
  "notes" : [{ // Notes
    "type" : { Coding }, // display | print | printoper
    "text" : "<string>" // Notes text
  }],
  "error" : [{ Coding }] // Error code
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. StatusResponse DomainResourceStatusResponse resource
... identifier 0..*IdentifierBusiness Identifier
... request 0..1AnyRequest reference
... outcome 0..1CodingProcessing outcome
ProcessingOutcome (Example)
... disposition 0..1stringDisposition Message
... ruleset 0..1CodingResource version
Ruleset (Example)
... originalRuleset 0..1CodingOriginal version
Ruleset (Example)
... created 0..1dateTimeCreation date
... organization 0..1OrganizationInsurer
... requestProvider 0..1PractitionerResponsible practitioner
... requestOrganization 0..1OrganizationResponsible organization
... form 0..1CodingPrinted Form Identifier
Forms (Incomplete)
... notes 0..*ElementNotes
.... type 0..1Codingdisplay | print | printoper
NoteType (Incomplete)
.... text 0..1stringNotes text
... error 0..*CodingError code
AdjudicationError (Incomplete)

UML Diagram

StatusResponse (DomainResource)The Response Business Identifieridentifier : Identifier 0..*Original request resource referencerequest : Reference(Any) 0..1Transaction status: error, complete, heldoutcome : Coding 0..1 « (Local status of outcome codesProcessingOutcome) »A description of the status of the adjudication or processingdisposition : string 0..1The 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 the enclosed suite of services were performed or completedcreated : dateTime 0..1The Insurer who produced this adjudicated responseorganization : Reference(Organization) 0..1The practitioner who is responsible for the services rendered to the patientrequestProvider : Reference(Practitioner) 0..1The organization which is responsible for the services rendered to the patientrequestOrganization : Reference(Organization) 0..1The form to be used for printing the contentform : Coding 0..1 « The forms codesForms+ »Processing errorserror : Coding 0..* « The error codes for adjudication processingAdjudicationError+ »NotesThe note purpose: Print/Displaytype : Coding 0..1 « The presentation types of notesNoteType+ »The note texttext : string 0..1Suite of processing note or additional requirements is the processing has been heldnotes0..*

XML Template

<StatusResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <request><!-- 0..1 Reference(Any) Request reference --></request>
 <outcome><!-- 0..1 Coding Processing outcome --></outcome>
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <organization><!-- 0..1 Reference(Organization) Insurer --></organization>
 <requestProvider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
 <form><!-- 0..1 Coding Printed Form Identifier --></form>
 <notes>  <!-- 0..* Notes -->
  <type><!-- 0..1 Coding display | print | printoper --></type>
  <text value="[string]"/><!-- 0..1 Notes text -->
 </notes>
 <error><!-- 0..* Coding Error code --></error>
</StatusResponse>

JSON Template

{doco
  "resourceType" : "StatusResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "request" : { Reference(Any) }, // Request reference
  "outcome" : { Coding }, // Processing outcome
  "disposition" : "<string>", // Disposition Message
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  "organization" : { Reference(Organization) }, // Insurer
  "requestProvider" : { Reference(Practitioner) }, // Responsible practitioner
  "requestOrganization" : { Reference(Organization) }, // Responsible organization
  "form" : { Coding }, // Printed Form Identifier
  "notes" : [{ // Notes
    "type" : { Coding }, // display | print | printoper
    "text" : "<string>" // Notes text
  }],
  "error" : [{ Coding }] // Error code
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

7.18.2.1 Terminology Bindings

PathDefinitionTypeReference
StatusResponse.outcome Local status of outcome codesExamplehttp://hl7.org/fhir/vs/process-outcome
StatusResponse.ruleset
StatusResponse.originalRuleset 		The static and dynamic model to which contents conform, may be business version or standard and version.Examplehttp://hl7.org/fhir/vs/ruleset
StatusResponse.form The forms codesIncompletehttp://hl7.org/fhir/vs/forms
StatusResponse.notes.type The presentation types of notesFixedhttp://hl7.org/fhir/NT-link
StatusResponse.error The error codes for adjudication processingIncompletehttp://hl7.org/fhir/vs/adjudication-error

7.18.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
identifiertokenThe business identifier of the Explanation of BenefitStatusResponse.identifier