Athena Core Implementation Guide
5.5.0 - release
Athena Core Implementation Guide
5.5.0 - release
Athena Core Implementation Guide - Local Development build (v5.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.athena.io/StructureDefinition/ah-binary | Version: 5.5.0 | |||
| Active as of 2025-11-13 | Computable Name: AthenahealthBinary | |||
| Keywords: Wire Format | ||||
A resource that represents the data of a single raw artifact as digital content accessible in its native format.
There are situations where it is useful or required to handle pure binary content using the same framework as other resources. Typically, this is when the binary content is referred to from other FHIR Resources. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Binary
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Binary |
0..* | Binary | Pure binary content defined by a format other than FHIR | |
  meta |
||||
  lastUpdated |
0..1 | instant | When the resource version last changed | |
 security |
0..* | Coding | Security Labels applied to this resource | |
| securityContext |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Binary |
0..* | Binary | Pure binary content defined by a format other than FHIR | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Binary.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Binary |
0..* | Binary | Pure binary content defined by a format other than FHIR | |||||
| id |
Σ | 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 | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| 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.
| |||||
| 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. | ||||
| data |
0..1 | base64Binary | The actual content | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Binary.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Binary.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Binary.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Binary.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
This structure is derived from Binary
Differential View
This structure is derived from Binary
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Binary |
0..* | Binary | Pure binary content defined by a format other than FHIR | |
| meta |
||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |
| security |
0..* | Coding | Security Labels applied to this resource | |
| securityContext |
0..0 | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Binary |
0..* | Binary | Pure binary content defined by a format other than FHIR | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Binary.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Binary |
0..* | Binary | Pure binary content defined by a format other than FHIR | |||||
| id |
Σ | 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 | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| 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.
| |||||
| 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. | ||||
| data |
0..1 | base64Binary | The actual content | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Binary.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Binary.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Binary.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Binary.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
This structure is derived from Binary
Other representations of profile: CSV, Excel, Schematron