Implementation Guide
25.0.0 - R4 APIs

Publish Box goes here

Logical Model: Profile - Athena Custom OperationOutcome

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition-athena-operationOutcome-profile.html Version: 25.0.0
Active as of 2023-03-01 Computable Name: OperationOutcome

The operation outcome resource records the details of external attachments that are not copied while doing an EHI export of patients.

This Operation Outcome resource is part of the EHI export binary resource supported by the API Server used with in the athenaPractice and athenaFlow products. Note: The read and search operations are NOT supported for this resource.

Overview

This resource records the error details that has occurred while doing an EHI export of patients having external attachments.

Scope and Usage

There could be external attachments added for a patient. While doing an EHI export for that particular patient, there will be an attempt to copy the external attachments to the location configured by QIE server. If the attachment could not be copied successfully, then an entry is added to the operation outcome resource. The status of EHI export job will still be "Complete" and the response status code will be 200, but the error details will be logged into the OperationOutcome resource. Operation outcome resource could be output for both DocumentReference attachments and other unexpected activity that happens during EHI Export processing.

Source

The operation outcome resource will hold the details of the source location of the external attachment and also the destination location details if it encounters any issues in copying.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-operationOutcome-profile 0..* Base
... id SΣ 1..1 id External reference id
... issue 0..2 BackboneElement Issue Details
ele-1: All FHIR elements must have a @value or children
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... details 0..1 CodeableConcept Issue Details
.... coding 0..1 code Operation outcome codes
.... system 0..1 uri Identity of the terminology system
.... code 0..1 code Symbol in syntax defined by the system
.... display 0..1 string Representation defined by the system
.... text 0..1 string Plain text representation of the concept
.... severity 0..1 code Severity of the issue
.... diagnostics 0..1 string Diagnostic information

doco Documentation for this format

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-operationOutcome-profile 0..* Base
... id SΣ 1..1 id External reference id
... issue 0..2 BackboneElement Issue Details
.... details 0..1 CodeableConcept Issue Details
.... coding 0..1 code Operation outcome codes
.... system 0..1 uri Identity of the terminology system
.... code 0..1 code Symbol in syntax defined by the system
.... display 0..1 string Representation defined by the system
.... text 0..1 string Plain text representation of the concept
.... severity 0..1 code Severity of the issue
.... diagnostics 0..1 string Diagnostic information

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-operationOutcome-profile 0..* Base
... id SΣ 1..1 id External reference id
... issue 0..2 BackboneElement Issue Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... details 0..1 CodeableConcept Issue Details
.... coding 0..1 code Operation outcome codes
.... system 0..1 uri Identity of the terminology system
.... code 0..1 code Symbol in syntax defined by the system
.... display 0..1 string Representation defined by the system
.... text 0..1 string Plain text representation of the concept
.... severity 0..1 code Severity of the issue
.... diagnostics 0..1 string Diagnostic information

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 1 element

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-operationOutcome-profile 0..* Base
... id SΣ 1..1 id External reference id
... issue 0..2 BackboneElement Issue Details
ele-1: All FHIR elements must have a @value or children
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... details 0..1 CodeableConcept Issue Details
.... coding 0..1 code Operation outcome codes
.... system 0..1 uri Identity of the terminology system
.... code 0..1 code Symbol in syntax defined by the system
.... display 0..1 string Representation defined by the system
.... text 0..1 string Plain text representation of the concept
.... severity 0..1 code Severity of the issue
.... diagnostics 0..1 string Diagnostic information

doco Documentation for this format

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-operationOutcome-profile 0..* Base
... id SΣ 1..1 id External reference id
... issue 0..2 BackboneElement Issue Details
.... details 0..1 CodeableConcept Issue Details
.... coding 0..1 code Operation outcome codes
.... system 0..1 uri Identity of the terminology system
.... code 0..1 code Symbol in syntax defined by the system
.... display 0..1 string Representation defined by the system
.... text 0..1 string Plain text representation of the concept
.... severity 0..1 code Severity of the issue
.... diagnostics 0..1 string Diagnostic information

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-operationOutcome-profile 0..* Base
... id SΣ 1..1 id External reference id
... issue 0..2 BackboneElement Issue Details
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... details 0..1 CodeableConcept Issue Details
.... coding 0..1 code Operation outcome codes
.... system 0..1 uri Identity of the terminology system
.... code 0..1 code Symbol in syntax defined by the system
.... display 0..1 string Representation defined by the system
.... text 0..1 string Plain text representation of the concept
.... severity 0..1 code Severity of the issue
.... diagnostics 0..1 string Diagnostic information

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 1 element

 

Other representations of profile: CSV, Excel

Notes:

Supported Extensions

The external attachments of the following types are supported for copying.

PNG JPG JPEG GIF TIF RTF PDF XML HTML GZIP

Supported Monikers

The external attachments from the following locations are supported for copying.

http https C: D: Shared Network Drive

When we try to copy any attachments that are not from the above listed conditions, the image will not be copied and error message will be logged into OperationOutcome resource.