CH RAD-Order (R4)
0.1.0 - STU 1 Ballot

CH RAD-Order (R4), published by HL7 Switzerland. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/hl7ch/ch-rad-order/ and changes regularly. See the Directory of published versions

Resource Profile: CH RAD-Order Media

Defining URL:http://fhir.ch/ig/ch-rad-order/StructureDefinition/ch-rad-order-media
Version:0.1.0
Name:ChRadOrderMedia
Title:CH RAD-Order Media
Status:Active as of 12/2/21, 11:24 PM
Definition:

Definition for the Media resource in the context of CH RAD-Order.

Publisher:HL7 Switzerland
Copyright:

CC-BY-SA-4.0

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://fhir.ch/ig/ch-rad-order/StructureDefinition/ch-rad-order-media

Formal Views of Profile Content

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

This structure is derived from Media

Summary

Must-Support: 5 elements

This structure is derived from Media

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..*MediaCH RAD-Order Media
... status S1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... content S1..1AttachmentActual Media - reference or data
.... contentType S0..1codeMime type of the content, with charset etc.
.... data S0..1base64BinaryData inline, base64ed
.... title S0..1stringProvide filename and extension (e.g. "shoulder_re_F_Muster_12021988.pdf")

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..*MediaCH RAD-Order Media
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(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..1codepreparation | 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..1CodeableConceptClassification of media as image, video, or audio
Binding: MediaType (extensible): Codes for high level media categories.

... modality Σ0..1CodeableConceptThe 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..1CodeableConceptImaging view, e.g. Lateral or Antero-posterior
Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image.

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


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

... deviceName Σ0..1stringName of the device/manufacturer
... device Σ0..1Reference(Device | DeviceMetric | Device)Observing Device
... height Σ0..1positiveIntHeight of the image in pixels (photo/video)
... width Σ0..1positiveIntWidth of the image in pixels (photo/video)
... frames Σ0..1positiveIntNumber of frames if > 1 (photo)
... duration Σ0..1decimalLength in seconds (audio / video)
... content SΣ1..1AttachmentActual Media - reference or data
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType SΣ0..1codeMime 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..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.


Example General: en-AU
.... data S0..1base64BinaryData inline, base64ed
.... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
.... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
.... title SΣ0..1stringProvide filename and extension (e.g. "shoulder_re_F_Muster_12021988.pdf")
Example General: Official Corporate Logo
.... creation Σ0..1dateTimeDate attachment was first created
... note 0..*AnnotationComments made about the media

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..*MediaCH RAD-Order Media
... status ?!Σ1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): Codes identifying the lifecycle stage of an event.

... content Σ1..1AttachmentActual Media - reference or data
.... contentType Σ0..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

.... data 0..1base64BinaryData inline, base64ed
.... title Σ0..1stringProvide filename and extension (e.g. "shoulder_re_F_Muster_12021988.pdf")

doco Documentation for this format

This structure is derived from Media

Summary

Must-Support: 5 elements

Differential View

This structure is derived from Media

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..*MediaCH RAD-Order Media
... status S1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... content S1..1AttachmentActual Media - reference or data
.... contentType S0..1codeMime type of the content, with charset etc.
.... data S0..1base64BinaryData inline, base64ed
.... title S0..1stringProvide filename and extension (e.g. "shoulder_re_F_Muster_12021988.pdf")

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..*MediaCH RAD-Order Media
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(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..1codepreparation | 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..1CodeableConceptClassification of media as image, video, or audio
Binding: MediaType (extensible): Codes for high level media categories.

... modality Σ0..1CodeableConceptThe 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..1CodeableConceptImaging view, e.g. Lateral or Antero-posterior
Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image.

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


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

... deviceName Σ0..1stringName of the device/manufacturer
... device Σ0..1Reference(Device | DeviceMetric | Device)Observing Device
... height Σ0..1positiveIntHeight of the image in pixels (photo/video)
... width Σ0..1positiveIntWidth of the image in pixels (photo/video)
... frames Σ0..1positiveIntNumber of frames if > 1 (photo)
... duration Σ0..1decimalLength in seconds (audio / video)
... content SΣ1..1AttachmentActual Media - reference or data
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType SΣ0..1codeMime 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..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.


Example General: en-AU
.... data S0..1base64BinaryData inline, base64ed
.... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
.... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
.... title SΣ0..1stringProvide filename and extension (e.g. "shoulder_re_F_Muster_12021988.pdf")
Example General: Official Corporate Logo
.... creation Σ0..1dateTimeDate attachment was first created
... note 0..*AnnotationComments made about the media

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Media.languagepreferredCommonLanguages
Max Binding: AllLanguages
Media.statusrequiredEventStatus
Media.typeextensibleMediaType
Media.modalityexampleMediaModality
Media.viewexampleMediaCollectionView/Projection
Media.reasonCodeexampleProcedureReasonCodes
Media.bodySiteexampleSNOMEDCTBodyStructures
Media.content.contentTyperequiredMime Types
Media.content.languagepreferredCommonLanguages
Max Binding: AllLanguages

Constraints

IdPathDetailsRequirements
dom-2MediaIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3MediaIf 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-4MediaIf 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-5MediaIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6MediaA resource should have narrative for robust management
: text.`div`.exists()
ele-1Media.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Media.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Media.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Media.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Media.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.modalityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.viewAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.created[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.issuedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.operatorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.bodySiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.deviceNameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.deviceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.heightAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.widthAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.framesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.durationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.contentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.content.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Media.content.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Media.content.contentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.content.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.content.dataAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.content.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.content.sizeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.content.hashAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.content.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.content.creationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Media.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())