ESMD FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: Esmd Binary Profile

The Esmd-Binary profile extends the HL7 Binary resource. It is used to return the encoded document payload when an authorized HIH requests to download or redownload a clinical document payload or esMD system reference data file from the esMD System's secure storage.

Usage:

• Examples for this Resource Profile: Binary/a6e9ea73-e38d-4a77-b629-4984c58cda4f
• CapabilityStatements using this Resource Profile: esMD FHIR Server Capability Statement

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Binary		0..*	Binary	Pure binary content defined by a format other than FHIR
id	SΣ	1..1	id	Logical id of this artifact
meta	SΣ	0..1	EsmdMeta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children
security	SΣC	1..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children inv-esmd-meta-security-01: esMD supports only V security code
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
data	S	1..1	base64Binary	The actual content ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Binary.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Binary.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
inv-esmd-meta-security-01	error	Binary.meta.security	esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST')

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
id	S	1..1	id	Logical id of this artifact
meta	S	0..1	EsmdMeta	Metadata about the resource
profile		1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	S	1..*	Coding	Security Labels applied to this resource
contentType		1..1	code	MimeType of the binary content
data	S	1..1	base64Binary	The actual content
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Binary		0..*	Binary	Pure binary content defined by a format other than FHIR
id	SΣ	1..1	id	Logical id of this artifact
meta	SΣ	0..1	EsmdMeta	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	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
security	SΣC	1..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. inv-esmd-meta-security-01: esMD supports only V security code
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 Bindings Purpose AllLanguages Max Binding
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	S	1..1	base64Binary	The actual content
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Binary.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Binary.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Binary.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Binary.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-esmd-meta-security-01	error	Binary.meta.security	esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST')

This structure is derived from Binary

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• esMD Meta (https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Meta)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Binary		0..*	Binary	Pure binary content defined by a format other than FHIR
id	SΣ	1..1	id	Logical id of this artifact
meta	SΣ	0..1	EsmdMeta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children
security	SΣC	1..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children inv-esmd-meta-security-01: esMD supports only V security code
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
data	S	1..1	base64Binary	The actual content ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Binary.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Binary.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
inv-esmd-meta-security-01	error	Binary.meta.security	esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST')

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
id	S	1..1	id	Logical id of this artifact
meta	S	0..1	EsmdMeta	Metadata about the resource
profile		1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	S	1..*	Coding	Security Labels applied to this resource
contentType		1..1	code	MimeType of the binary content
data	S	1..1	base64Binary	The actual content
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Binary		0..*	Binary	Pure binary content defined by a format other than FHIR
id	SΣ	1..1	id	Logical id of this artifact
meta	SΣ	0..1	EsmdMeta	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	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:$this
security	SΣC	1..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. inv-esmd-meta-security-01: esMD supports only V security code
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 Bindings Purpose AllLanguages Max Binding
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	S	1..1	base64Binary	The actual content
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Binary.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Binary.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Binary.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Binary.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-esmd-meta-security-01	error	Binary.meta.security	esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST')

This structure is derived from Binary

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• esMD Meta (https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Meta)

Other representations of profile: CSV, Excel, Schematron