Implementation Guide
23.0.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena Media

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition-athena-media-profile.html Version: 23.0.0
Active as of 2022-08-23 Computable Name: AthenaMedia

athena media profile

This Media 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 and search capabilities of these products.

Overview

The Media resource contains photos, videos, and audio recordings. It is used with media acquired or used as part of the healthcare process.

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 Media 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 Media resource is derived from the EXTREFERENCES, DOCIMAGES tables in athenaPractice and also same tables in athenaFlow. Specific details are as follows:

athenaPractice / athenaFlow
Table
Information in Resource
Both ExtReferences

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.
Both DocImages 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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..* Media A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-media-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-media-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): Codes identifying the lifecycle stage of an event.


Fixed Value: completed
... subject Σ 0..1 Reference(Patient) Who/What this Media is a record of
... encounter Σ 0..1 Reference(Encounter) Encounter associated with media
... created[x] Σ 0..1 dateTime When Media was collected
... content SΣ 1..1 Attachment Actual Media - reference or data
.... data 0..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Media.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard

This structure is derived from Media

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..* Media A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... Type 0..1 CodeableConcept
... id S 0..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... versionId 0..1 id Version specific identifier
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-media-profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-media-profile
... subject 0..1 Reference(Patient) Who/What this Media is a record of
... encounter 0..1 Reference(Encounter) Encounter associated with media
... created[x] 0..1 dateTime When Media was collected
... content S 1..1 Attachment Actual Media - reference or data
.... data 0..1 base64Binary Data inline, base64ed
.... url 0..1 url Uri where the data can be found
.... title 0..1 string Label to display in place of the data

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..* Media A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... id SΣ 0..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-media-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-media-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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifier(s) for the image
... basedOn Σ 0..* Reference(ServiceRequest | CarePlan) Procedure that caused this media to be created
... partOf Σ 0..* Reference(Resource) Part of referenced event
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): Codes identifying the lifecycle stage of an event.


Fixed Value: completed
... type Σ 0..1 CodeableConcept Classification of media as image, video, or audio
Binding: MediaType (extensible): Codes for high level media categories.

... modality Σ 0..1 CodeableConcept The type of acquisition equipment/process
Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it.

... view Σ 0..1 CodeableConcept Imaging view, e.g. Lateral or Antero-posterior
Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image.

... subject Σ 0..1 Reference(Patient) Who/What this Media is a record of
... encounter Σ 0..1 Reference(Encounter) Encounter associated with media
... created[x] Σ 0..1 dateTime When Media was collected
... issued Σ 0..1 instant Date/Time this version was made available
... operator Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The person who generated the image
... reasonCode Σ 0..* CodeableConcept Why was event performed?
Binding: ProcedureReasonCodes (example): The reason for the media.


... bodySite Σ 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... deviceName Σ 0..1 string Name of the device/manufacturer
... device Σ 0..1 Reference(Device | DeviceMetric | Device) Observing Device
... height Σ 0..1 positiveInt Height of the image in pixels (photo/video)
... width Σ 0..1 positiveInt Width of the image in pixels (photo/video)
... frames Σ 0..1 positiveInt Number of frames if > 1 (photo)
... duration Σ 0..1 decimal Length in seconds (audio / video)
... content SΣ 1..1 Attachment Actual Media - reference or data
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data 0..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created
... note 0..* Annotation Comments made about the media

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Media.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Media.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Media.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Media.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Media.typeextensibleMediaType
http://hl7.org/fhir/ValueSet/media-type
from the FHIR Standard
Media.modalityexampleMediaModality
http://hl7.org/fhir/ValueSet/media-modality
from the FHIR Standard
Media.viewexampleMediaCollectionView/Projection
http://hl7.org/fhir/ValueSet/media-view
from the FHIR Standard
Media.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
Media.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Media.content.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Media.content.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

This structure is derived from Media

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 3 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..* Media A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-media-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-media-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): Codes identifying the lifecycle stage of an event.


Fixed Value: completed
... subject Σ 0..1 Reference(Patient) Who/What this Media is a record of
... encounter Σ 0..1 Reference(Encounter) Encounter associated with media
... created[x] Σ 0..1 dateTime When Media was collected
... content SΣ 1..1 Attachment Actual Media - reference or data
.... data 0..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Media.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard

Differential View

This structure is derived from Media

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..* Media A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... Type 0..1 CodeableConcept
... id S 0..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... versionId 0..1 id Version specific identifier
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-media-profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-media-profile
... subject 0..1 Reference(Patient) Who/What this Media is a record of
... encounter 0..1 Reference(Encounter) Encounter associated with media
... created[x] 0..1 dateTime When Media was collected
... content S 1..1 Attachment Actual Media - reference or data
.... data 0..1 base64Binary Data inline, base64ed
.... url 0..1 url Uri where the data can be found
.... title 0..1 string Label to display in place of the data

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..* Media A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... id SΣ 0..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-media-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-media-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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifier(s) for the image
... basedOn Σ 0..* Reference(ServiceRequest | CarePlan) Procedure that caused this media to be created
... partOf Σ 0..* Reference(Resource) Part of referenced event
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): Codes identifying the lifecycle stage of an event.


Fixed Value: completed
... type Σ 0..1 CodeableConcept Classification of media as image, video, or audio
Binding: MediaType (extensible): Codes for high level media categories.

... modality Σ 0..1 CodeableConcept The type of acquisition equipment/process
Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it.

... view Σ 0..1 CodeableConcept Imaging view, e.g. Lateral or Antero-posterior
Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image.

... subject Σ 0..1 Reference(Patient) Who/What this Media is a record of
... encounter Σ 0..1 Reference(Encounter) Encounter associated with media
... created[x] Σ 0..1 dateTime When Media was collected
... issued Σ 0..1 instant Date/Time this version was made available
... operator Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The person who generated the image
... reasonCode Σ 0..* CodeableConcept Why was event performed?
Binding: ProcedureReasonCodes (example): The reason for the media.


... bodySite Σ 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... deviceName Σ 0..1 string Name of the device/manufacturer
... device Σ 0..1 Reference(Device | DeviceMetric | Device) Observing Device
... height Σ 0..1 positiveInt Height of the image in pixels (photo/video)
... width Σ 0..1 positiveInt Width of the image in pixels (photo/video)
... frames Σ 0..1 positiveInt Number of frames if > 1 (photo)
... duration Σ 0..1 decimal Length in seconds (audio / video)
... content SΣ 1..1 Attachment Actual Media - reference or data
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data 0..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created
... note 0..* Annotation Comments made about the media

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Media.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Media.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Media.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Media.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Media.typeextensibleMediaType
http://hl7.org/fhir/ValueSet/media-type
from the FHIR Standard
Media.modalityexampleMediaModality
http://hl7.org/fhir/ValueSet/media-modality
from the FHIR Standard
Media.viewexampleMediaCollectionView/Projection
http://hl7.org/fhir/ValueSet/media-view
from the FHIR Standard
Media.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
Media.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Media.content.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Media.content.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

This structure is derived from Media

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 3 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Media resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/r4/Media?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer
[_count] Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Media resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token) The ID of the resource.
subject (reference) The identity of a patient to list Media for.
patient (reference) The identity of a patient to list Media for.
encounter (reference) The identity of a encounter to list Media of.
created (date) Returns Media created on this date.
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.