Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena Binary

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-binary-profile Version: 23.1.0
Active as of 2022-03-01 Computable Name: AthenaBinary

Defines constraints and extensions on the Binary resource as supported by Athena Products.

This Binary profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read capabilities of these products. Note: The create and update operations are supported for this resource.

Overview

The Binary resource represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access Binary resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The Binary resource is derived from the PatientProfileAttachment, PatientVisitAttachment, PatientProfile, Document, and DOCIMAGE tables in athenaPractice and PERSON_PICT, Document, and DOCIMAGE tables in athenaFlow. Specific details are as follows:

athenaPractice / athenaFlow
ID Prefix
Information in Resource
Both Photo athenaPractice PatientProfile Picture, athenaFlow PERSON_PICT
Both DOC

Chart documents created by athenaPractice/athenaFlow
Both DD CCDAs imported into athenaPractice/athenaFlow
Both EXT

Content from external references to Chart documents

NOTE: There is limited support for external references due to complexities in managing and configuring access to network resources.

The beginning path components are configured in the SUPPORTEDMONIKERS entry in mappings.properties file for athenaPractice API Server.

#Supported Monikers
SUPPORTEDMONIKERS=http|C:|D:|\\

There still may be issues if athenaPractice Interop Server is not able to connect to the specified path

  • Monikers with file paths for C or D drives often refer to disk drives accessible from athenaPractice client application but not accessible to any of the JBoss servers.
  • Universal naming convention for internal network paths may or may not work depending on whether athenaPractice Interop Server is configured to be able to access those resources.
  • Some simple URLs for resources accessed through http will work assuming Interop server is able to establish simple URL connection to the requested web resource.

It would be best practice for all uses of Binary resource to check for possible errors when attempting to access Chart document external references through Binary.id=ETX-EXTREFID.

athenaPractice only PPA PatientProfileAttachment
athenaPractice only PVA PatientVisitAttachment
Both INT Content from internal images embedded in Chart documents. Contact athenahealth for assistance with interpreting the proprietary format used for these images.

Usage:

Formal Views of Profile Content

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

This structure is derived from Binary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Binary 0..* Binary Pure binary content defined by a format other than FHIR
... id 1..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-binary 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-binary-profile
... contentType 1..1 code MimeType of the binary content

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Binary 0..* Binary Pure binary content defined by a format other than FHIR
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-binary Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-binary-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... data 0..1 base64Binary The actual content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Binary.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Binary 0..* Binary Pure binary content defined by a format other than FHIR
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-binary Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-binary-profile
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contentType Σ 1..1 code MimeType of the binary content
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

... securityContext Σ 0..1 Reference(Resource) Identifies another resource to use as proxy when enforcing access control
... data 0..1 base64Binary The actual content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Binary.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Binary.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Binary.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Binary.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

This structure is derived from Binary

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Fixed: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Binary.meta.profile

Differential View

This structure is derived from Binary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Binary 0..* Binary Pure binary content defined by a format other than FHIR
... id 1..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-binary 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-binary-profile
... contentType 1..1 code MimeType of the binary content

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Binary 0..* Binary Pure binary content defined by a format other than FHIR
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-binary Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-binary-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... data 0..1 base64Binary The actual content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Binary.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Binary 0..* Binary Pure binary content defined by a format other than FHIR
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-binary Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-binary-profile
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contentType Σ 1..1 code MimeType of the binary content
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

... securityContext Σ 0..1 Reference(Resource) Identifies another resource to use as proxy when enforcing access control
... data 0..1 base64Binary The actual content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Binary.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Binary.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Binary.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Binary.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

This structure is derived from Binary

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Fixed: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Binary.meta.profile

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

Interactions supported by this resource are listed below.