HL7 CZ Laboratory IG
0.5.0 - ci-build Czechia flag

HL7 CZ Laboratory IG, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/cz-lab/ and changes regularly. See the Directory of published versions

Resource Profile: Attachment: Obligations

Official URL: https://hl7.cz/fhir/lab/StructureDefinition/cz-attachment-obl-lab Version: 0.5.0
Draft as of 2025-11-10 Computable Name: CZ_AttachmentObligationsLab

This profile defines obligations for an attachment in FHIR for the purpose of this guide.

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Media 0..* CZ_Attachment Lab Report attachment
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 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.
... height OΣ 0..1 positiveInt Height of the image in pixels (photo/video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... width OΣ 0..1 positiveInt Width of the image in pixels (photo/video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... frames OΣ 0..1 positiveInt Number of frames if > 1 (photo)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... duration OΣ 0..1 decimal Length in seconds (audio / video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... content Σ 1..1 Attachment Actual Media - reference or data
.... contentType SOΣ 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
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... language SOΣ 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
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... data O 0..1 base64Binary Data inline, base64ed
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... url SOΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... size OΣ 0..1 unsignedInt Number of bytes of content (if url provided)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
.... hash OΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
.... title SOΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... creation SOΣ 0..1 dateTime Date attachment was first created
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Media.status Base required EventStatus 📍4.0.1 FHIR Std.
Media.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Media.content.contentType Base required MimeType 📍4.0.1 FHIR Std.
Media.content.language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Media If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Media If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Media If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Media If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Media A resource should have narrative for robust management text.`div`.exists()
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()

This structure is derived from CZ_Attachment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Media 0..* CZ_Attachment Lab Report attachment
... bodySite O 0..1 CodeableConcept Observed body part
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
... height O 0..1 positiveInt Height of the image in pixels (photo/video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... width O 0..1 positiveInt Width of the image in pixels (photo/video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... duration O 0..1 decimal Length in seconds (audio / video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... content
.... contentType O 0..1 code Mime type of the content, with charset etc.
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... language O 0..1 code Human language of the content (BCP-47)
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... data O 0..1 base64Binary Data inline, base64ed
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... url O 0..1 url Uri where the data can be found
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... size O 0..1 unsignedInt Number of bytes of content (if url provided)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
.... hash O 0..1 base64Binary Hash of the data (sha-1, base64ed)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
.... title O 0..1 string Label to display in place of the data
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... creation O 0..1 dateTime Date attachment was first created
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Media 0..* CZ_Attachment Lab Report attachment
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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: Laboratory Order | CarePlan) Procedure that caused this media to be created
... partOf Σ 0..* Reference(Resource) Part of referenced event
... status ?!Σ 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.
... 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 (CZ core) | Practitioner (CZ core) | Practitioner Role (CZ core) | Group | Device | Specimen Laboratory (CZ) | Location (CZ core)) Who/What this Media is a record of
... encounter Σ 0..1 Reference(Encounter) Encounter associated with media
... created[x] Σ 0..1 When Media was collected
.... createdDateTime dateTime
.... createdPeriod Period
... issued Σ 0..1 instant Date/Time this version was made available
... operator Σ 0..1 Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | Organization (CZ core) | CareTeam | Patient (CZ core) | Device | Related Person (CZ core)) The person who generated the image
... reasonCode Σ 0..* CodeableConcept Why was event performed?
Binding: ProcedureReasonCodes (example): The reason for the media.
... bodySite OΣ 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
... deviceName Σ 0..1 string Name of the device/manufacturer
... device Σ 0..1 Reference(Device | DeviceMetric | Device) Observing Device
... height OΣ 0..1 positiveInt Height of the image in pixels (photo/video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... width OΣ 0..1 positiveInt Width of the image in pixels (photo/video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... frames OΣ 0..1 positiveInt Number of frames if > 1 (photo)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... duration OΣ 0..1 decimal Length in seconds (audio / video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... content Σ 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 SOΣ 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
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... language SOΣ 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
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... data O 0..1 base64Binary Data inline, base64ed
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... url SOΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... size OΣ 0..1 unsignedInt Number of bytes of content (if url provided)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
.... hash OΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
.... title SOΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... creation SOΣ 0..1 dateTime Date attachment was first created
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
... note 0..* Annotation Comments made about the media

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Media.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Media.status Base required EventStatus 📍4.0.1 FHIR Std.
Media.type Base extensible Media Type 📍4.0.1 FHIR Std.
Media.modality Base example Media Modality 📍4.0.1 FHIR Std.
Media.view Base example Media Collection View/Projection 📍4.0.1 FHIR Std.
Media.reasonCode Base example Procedure Reason Codes 📍4.0.1 FHIR Std.
Media.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Media.content.contentType Base required MimeType 📍4.0.1 FHIR Std.
Media.content.language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Media If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Media If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Media If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Media If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Media A resource should have narrative for robust management text.`div`.exists()
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()

This structure is derived from CZ_Attachment

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Media 0..* CZ_Attachment Lab Report attachment
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 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.
... height OΣ 0..1 positiveInt Height of the image in pixels (photo/video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... width OΣ 0..1 positiveInt Width of the image in pixels (photo/video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... frames OΣ 0..1 positiveInt Number of frames if > 1 (photo)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... duration OΣ 0..1 decimal Length in seconds (audio / video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... content Σ 1..1 Attachment Actual Media - reference or data
.... contentType SOΣ 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
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... language SOΣ 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
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... data O 0..1 base64Binary Data inline, base64ed
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... url SOΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... size OΣ 0..1 unsignedInt Number of bytes of content (if url provided)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
.... hash OΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
.... title SOΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... creation SOΣ 0..1 dateTime Date attachment was first created
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Media.status Base required EventStatus 📍4.0.1 FHIR Std.
Media.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Media.content.contentType Base required MimeType 📍4.0.1 FHIR Std.
Media.content.language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Media If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Media If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Media If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Media If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Media A resource should have narrative for robust management text.`div`.exists()
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()

Differential View

This structure is derived from CZ_Attachment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Media 0..* CZ_Attachment Lab Report attachment
... bodySite O 0..1 CodeableConcept Observed body part
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
... height O 0..1 positiveInt Height of the image in pixels (photo/video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... width O 0..1 positiveInt Width of the image in pixels (photo/video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... duration O 0..1 decimal Length in seconds (audio / video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... content
.... contentType O 0..1 code Mime type of the content, with charset etc.
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... language O 0..1 code Human language of the content (BCP-47)
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... data O 0..1 base64Binary Data inline, base64ed
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... url O 0..1 url Uri where the data can be found
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... size O 0..1 unsignedInt Number of bytes of content (if url provided)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
.... hash O 0..1 base64Binary Hash of the data (sha-1, base64ed)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
.... title O 0..1 string Label to display in place of the data
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... creation O 0..1 dateTime Date attachment was first created
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Media 0..* CZ_Attachment Lab Report attachment
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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: Laboratory Order | CarePlan) Procedure that caused this media to be created
... partOf Σ 0..* Reference(Resource) Part of referenced event
... status ?!Σ 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.
... 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 (CZ core) | Practitioner (CZ core) | Practitioner Role (CZ core) | Group | Device | Specimen Laboratory (CZ) | Location (CZ core)) Who/What this Media is a record of
... encounter Σ 0..1 Reference(Encounter) Encounter associated with media
... created[x] Σ 0..1 When Media was collected
.... createdDateTime dateTime
.... createdPeriod Period
... issued Σ 0..1 instant Date/Time this version was made available
... operator Σ 0..1 Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | Organization (CZ core) | CareTeam | Patient (CZ core) | Device | Related Person (CZ core)) The person who generated the image
... reasonCode Σ 0..* CodeableConcept Why was event performed?
Binding: ProcedureReasonCodes (example): The reason for the media.
... bodySite OΣ 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
... deviceName Σ 0..1 string Name of the device/manufacturer
... device Σ 0..1 Reference(Device | DeviceMetric | Device) Observing Device
... height OΣ 0..1 positiveInt Height of the image in pixels (photo/video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... width OΣ 0..1 positiveInt Width of the image in pixels (photo/video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... frames OΣ 0..1 positiveInt Number of frames if > 1 (photo)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... duration OΣ 0..1 decimal Length in seconds (audio / video)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:process LabConsumer-L2
... content Σ 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 SOΣ 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
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... language SOΣ 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
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... data O 0..1 base64Binary Data inline, base64ed
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... url SOΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... size OΣ 0..1 unsignedInt Number of bytes of content (if url provided)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
.... hash OΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
.... title SOΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
ObligationsActor
SHOULD:able-to-populate LabCreator-L2
SHOULD:display LabConsumer-L2
.... creation SOΣ 0..1 dateTime Date attachment was first created
ObligationsActor
SHOULD:populate-if-known LabCreator-L2
SHOULD:display LabConsumer-L2
... note 0..* Annotation Comments made about the media

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Media.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Media.status Base required EventStatus 📍4.0.1 FHIR Std.
Media.type Base extensible Media Type 📍4.0.1 FHIR Std.
Media.modality Base example Media Modality 📍4.0.1 FHIR Std.
Media.view Base example Media Collection View/Projection 📍4.0.1 FHIR Std.
Media.reasonCode Base example Procedure Reason Codes 📍4.0.1 FHIR Std.
Media.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Media.content.contentType Base required MimeType 📍4.0.1 FHIR Std.
Media.content.language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Media If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Media If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Media If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Media If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Media A resource should have narrative for robust management text.`div`.exists()
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()

This structure is derived from CZ_Attachment

Summary

 

Other representations of profile: CSV, Excel, Schematron