0.4.4 - ci-build
StandardPatientHealthRecordIG, published by MITRE. This is not an authorized publication; it is the continuous build for version 0.4.4). This version is based on the current content of https://github.com/HL7/standard-patient-health-record-ig/ and changes regularly. See the Directory of published versions
| Draft as of 2023-09-13 |
XML representation of the PhrMedia resource profile.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="PhrMedia"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml">Placeholder</div>
</text>
<url
value="https://open-health-manager.github.io/standard-patient-health-record-ig/StructureDefinition/PhrMedia"/>
<version value="0.4.4"/>
<name value="PhrMedia"/>
<status value="draft"/>
<date value="2023-09-13T16:34:31+00:00"/>
<publisher value="MITRE"/>
<contact>
<name value="MITRE"/>
<telecom>
<system value="url"/>
<value
value="https://open-health-manager.github.io/standard-patient-health-record-ig"/>
</telecom>
</contact>
<description value="Standard PHR profile of the Media resource."/>
<fhirVersion value="4.0.1"/>
<mapping>
<identity value="workflow"/>
<uri value="http://hl7.org/fhir/workflow"/>
<name value="Workflow Pattern"/>
</mapping>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<mapping>
<identity value="w5"/>
<uri value="http://hl7.org/fhir/fivews"/>
<name value="FiveWs Pattern Mapping"/>
</mapping>
<mapping>
<identity value="dicom"/>
<uri value="http://nema.org/dicom"/>
<name value="DICOM Tag Mapping"/>
</mapping>
<mapping>
<identity value="v2"/>
<uri value="http://hl7.org/v2"/>
<name value="HL7 v2 Mapping"/>
</mapping>
<mapping>
<identity value="sct-concept"/>
<uri value="http://snomed.info/conceptdomain"/>
<name value="SNOMED CT Concept Domain Binding"/>
</mapping>
<mapping>
<identity value="sct-attr"/>
<uri value="http://snomed.org/attributebinding"/>
<name value="SNOMED CT Attribute Binding"/>
</mapping>
<kind value="resource"/>
<abstract value="false"/>
<type value="Media"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Media"/>
<derivation value="constraint"/>
<snapshot>
<element id="Media">
<path value="Media"/>
<short
value="A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference"/>
<definition
value="A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Media"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="dom-2"/>
<severity value="error"/>
<human
value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/>
<expression value="contained.contained.empty()"/>
<xpath value="not(parent::f:contained and f:contained)"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-3"/>
<severity value="error"/>
<human
value="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"/>
<expression
value="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()"/>
<xpath
value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-4"/>
<severity value="error"/>
<human
value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/>
<expression
value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/>
<xpath
value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-5"/>
<severity value="error"/>
<human
value="If a resource is contained in another resource, it SHALL NOT have a security label"/>
<expression value="contained.meta.security.empty()"/>
<xpath value="not(exists(f:contained/*/f:meta/f:security))"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation">
<valueMarkdown
value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."/>
</extension>
<key value="dom-6"/>
<severity value="warning"/>
<human
value="A resource should have narrative for robust management"/>
<expression value="text.`div`.exists()"/>
<xpath value="exists(f:text/h:div)"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="Entity. Role, or Act"/>
</mapping>
<mapping>
<identity value="workflow"/>
<map value="Event"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="Act[classCode="DGIMG", moodCode="EVN"]"/>
</mapping>
</element>
<element id="Media.id">
<path value="Media.id"/>
<short value="Logical id of this artifact"/>
<definition
value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/>
<comment
value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="id"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Media.meta">
<path value="Media.meta"/>
<short value="Metadata about the resource"/>
<definition
value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.meta"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Meta"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Media.implicitRules">
<path value="Media.implicitRules"/>
<short value="A set of rules under which this content was created"/>
<definition
value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc."/>
<comment
value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.implicitRules"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation"/>
<isSummary value="true"/>
</element>
<element id="Media.language">
<path value="Media.language"/>
<short value="Language of the resource content"/>
<definition
value="The base language in which the resource is written."/>
<comment
value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.language"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
<valueBoolean value="true"/>
</extension>
<strength value="preferred"/>
<description value="A human language."/>
<valueSet value="http://hl7.org/fhir/ValueSet/languages"/>
</binding>
</element>
<element id="Media.text">
<path value="Media.text"/>
<short value="Text summary of the resource, for human interpretation"/>
<definition
value="A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/>
<comment
value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later."/>
<alias value="narrative"/>
<alias value="html"/>
<alias value="xhtml"/>
<alias value="display"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="DomainResource.text"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Narrative"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="Act.text?"/>
</mapping>
</element>
<element id="Media.contained">
<path value="Media.contained"/>
<short value="Contained, inline Resources"/>
<definition
value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/>
<comment
value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels."/>
<alias value="inline resources"/>
<alias value="anonymous resources"/>
<alias value="contained resources"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.contained"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Resource"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Media.extension">
<path value="Media.extension"/>
<short value="Additional content defined by implementations"/>
<definition
value="May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/>
<comment
value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Media.modifierExtension">
<path value="Media.modifierExtension"/>
<short value="Extensions that cannot be ignored"/>
<definition
value="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."/>
<comment
value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<requirements
value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.modifierExtension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Media.identifier">
<path value="Media.identifier"/>
<short value="Identifier(s) for the image"/>
<definition
value="Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers."/>
<comment
value="The identifier label and use can be used to determine what kind of identifier it is."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Media.identifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Identifier"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Event.identifier"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.identifier"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".id"/>
</mapping>
<mapping>
<identity value="dicom"/>
<map value="0008,0018 | ~0008,0050 | 0020,000D | 0020,000E"/>
</mapping>
</element>
<element id="Media.basedOn">
<path value="Media.basedOn"/>
<short value="Procedure that caused this media to be created"/>
<definition
value="A procedure that is fulfilled in whole or in part by the creation of this media."/>
<requirements
value="Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon."/>
<alias value="fulfills"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Media.basedOn"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/ServiceRequest"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/CarePlan"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Event.basedOn"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".outboundRelationship[typeCode=FLFS].target"/>
</mapping>
</element>
<element id="Media.partOf">
<path value="Media.partOf"/>
<short value="Part of referenced event"/>
<definition
value="A larger event of which this particular event is a component or step."/>
<comment
value="Not to be used to link an event to an Encounter - use Media.encounter for that.
[The allowed reference resources may be adjusted as appropriate for the event resource]."/>
<requirements
value="E.g. Drug administration as part of a procedure, procedure as part of observation, etc."/>
<alias value="container"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Media.partOf"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Resource"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Event.partOf"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value=".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"/>
</mapping>
</element>
<element id="Media.status">
<path value="Media.status"/>
<short
value="preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown"/>
<definition value="The current state of the {{title}}."/>
<comment
value="A nominal state-transition diagram can be found in the [[event.html#statemachine | Event pattern]] documentation
Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Media.status"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="MediaStatus"/>
</extension>
<strength value="required"/>
<description
value="Codes identifying the lifecycle stage of an event."/>
<valueSet value="http://hl7.org/fhir/ValueSet/event-status|4.0.1"/>
</binding>
<mapping>
<identity value="workflow"/>
<map value="Event.status"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.status"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="Varies by domain"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".status"/>
</mapping>
</element>
<element id="Media.type">
<path value="Media.type"/>
<short value="Classification of media as image, video, or audio"/>
<definition
value="A code that classifies whether the media is an image, video or audio recording or some other media category."/>
<requirements
value="Used for filtering what observations are retrieved and displayed."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.type"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="MediaType"/>
</extension>
<strength value="extensible"/>
<description value="Codes for high level media categories."/>
<valueSet value="http://hl7.org/fhir/ValueSet/media-type"/>
</binding>
<mapping>
<identity value="w5"/>
<map value="FiveWs.class"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".code"/>
</mapping>
</element>
<element id="Media.modality">
<path value="Media.modality"/>
<short value="The type of acquisition equipment/process"/>
<definition
value="Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.modality"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="MediaModality"/>
</extension>
<strength value="example"/>
<description
value="Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it."/>
<valueSet value="http://hl7.org/fhir/ValueSet/media-modality"/>
</binding>
<mapping>
<identity value="workflow"/>
<map value="Event.code"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.what[x]"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value=".outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code"/>
</mapping>
<mapping>
<identity value="dicom"/>
<map value="0008,0060 | 0008,1032"/>
</mapping>
</element>
<element id="Media.view">
<path value="Media.view"/>
<short value="Imaging view, e.g. Lateral or Antero-posterior"/>
<definition
value="The name of the imaging view e.g. Lateral or Antero-posterior (AP)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.view"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="MediaView"/>
</extension>
<strength value="example"/>
<description
value="Imaging view (projection) used when collecting an image."/>
<valueSet value="http://hl7.org/fhir/ValueSet/media-view"/>
</binding>
<mapping>
<identity value="rim"/>
<map value="DiagnosticImage.subjectOrientationCode"/>
</mapping>
</element>
<element id="Media.subject">
<path value="Media.subject"/>
<short value="Who/What this Media is a record of"/>
<definition value="Who/What this Media is a record of."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.subject"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Patient"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/>
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Device"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Specimen"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Location"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Event.subject"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.subject[x]"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".participation[typeCode="SUBJ"]???"/>
</mapping>
<mapping>
<identity value="dicom"/>
<map value="~0010,0020"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.subject"/>
</mapping>
</element>
<element id="Media.encounter">
<path value="Media.encounter"/>
<short value="Encounter associated with media"/>
<definition
value="The encounter that establishes the context for this media."/>
<comment
value="This will typically be the encounter the media occurred within."/>
<requirements value="Links the Media to the Encounter context."/>
<alias value="context"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.encounter"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Encounter"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Event.encounter"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.context"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value=".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"/>
</mapping>
</element>
<element id="Media.created[x]">
<path value="Media.created[x]"/>
<short value="When Media was collected"/>
<definition
value="The date and time(s) at which the media was collected."/>
<alias value="timing"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.created[x]"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="dateTime"/>
</type>
<type>
<code value="Period"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Event.occurrence[x]"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.done[x]"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".effectiveTime"/>
</mapping>
</element>
<element id="Media.issued">
<path value="Media.issued"/>
<short value="Date/Time this version was made available"/>
<definition
value="The date and time this version of the media was made available to providers, typically after having been reviewed."/>
<comment
value="It may be the same as the [`lastUpdated` ](http://hl7.org/fhir/R4/resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that does not require the new version to be reviewed and verified again."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.issued"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="instant"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="w5"/>
<map value="FiveWs.recorded"/>
</mapping>
<mapping>
<identity value="v2"/>
<map
value="OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="participation[typeCode=AUT].time"/>
</mapping>
</element>
<element id="Media.operator">
<path value="Media.operator"/>
<short value="The person who generated the image"/>
<definition
value="The person who administered the collection of the image."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.operator"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Organization"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/CareTeam"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Patient"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Device"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Event.performer.actor"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.actor"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".participation[typeCode="PERF"]???"/>
</mapping>
<mapping>
<identity value="dicom"/>
<map value="0008,1060?"/>
</mapping>
</element>
<element id="Media.reasonCode">
<path value="Media.reasonCode"/>
<short value="Why was event performed?"/>
<definition
value="Describes why the event occurred in coded or textual form."/>
<comment
value="Textual reasons can be captured using reasonCode.text."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Media.reasonCode"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="MediaReason"/>
</extension>
<strength value="example"/>
<description value="The reason for the media."/>
<valueSet value="http://hl7.org/fhir/ValueSet/procedure-reason"/>
</binding>
<mapping>
<identity value="workflow"/>
<map value="Event.reasonCode"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.why[x]"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".reasonCode"/>
</mapping>
</element>
<element id="Media.bodySite">
<path value="Media.bodySite"/>
<short value="Observed body part"/>
<definition
value="Indicates the site on the subject's body where the observation was made (i.e. the target site)."/>
<comment
value="Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component.
If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension[ bodySite](http://hl7.org/fhir/R4/extension-bodysite.html)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.bodySite"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="BodySite"/>
</extension>
<strength value="example"/>
<description
value="Codes describing anatomical locations. May include laterality."/>
<valueSet value="http://hl7.org/fhir/ValueSet/body-site"/>
</binding>
<mapping>
<identity value="sct-concept"/>
<map value="< 123037004 |Body structure|"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="targetSiteCode"/>
</mapping>
<mapping>
<identity value="sct-attr"/>
<map value="718497002 |Inherent location|"/>
</mapping>
</element>
<element id="Media.deviceName">
<path value="Media.deviceName"/>
<short value="Name of the device/manufacturer"/>
<definition
value="The name of the device / manufacturer of the device that was used to make the recording."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.deviceName"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map
value=".participation[typeCode="DEV"].role.player.Entity[classCode="DEV"].name"/>
</mapping>
<mapping>
<identity value="dicom"/>
<map value="0008,0070"/>
</mapping>
</element>
<element id="Media.device">
<path value="Media.device"/>
<short value="Observing Device"/>
<definition value="The device used to collect the media."/>
<comment
value="An extension should be used if further typing of the device is needed. Secondary devices used to support collecting a media can be represented using either extension or through the Observation.related element."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.device"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Device"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/DeviceMetric"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Device"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="sct-concept"/>
<map value="< 49062001 |Device|"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="participation[typeCode=DEV]"/>
</mapping>
<mapping>
<identity value="sct-attr"/>
<map value="424226004 |Using device|"/>
</mapping>
</element>
<element id="Media.height">
<path value="Media.height"/>
<short value="Height of the image in pixels (photo/video)"/>
<definition value="Height of the image in pixels (photo/video)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.height"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="positiveInt"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map
value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN",code="<CODE>"].value"/>
</mapping>
<mapping>
<identity value="dicom"/>
<map value="0028,0010"/>
</mapping>
</element>
<element id="Media.width">
<path value="Media.width"/>
<short value="Width of the image in pixels (photo/video)"/>
<definition value="Width of the image in pixels (photo/video)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.width"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="positiveInt"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map
value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN",code="<CODE>"].value"/>
</mapping>
<mapping>
<identity value="dicom"/>
<map value="0028,0011"/>
</mapping>
</element>
<element id="Media.frames">
<path value="Media.frames"/>
<short value="Number of frames if > 1 (photo)"/>
<definition
value="The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required."/>
<comment
value="if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.frames"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="positiveInt"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map
value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN",code="<CODE>"].value"/>
</mapping>
</element>
<element id="Media.duration">
<path value="Media.duration"/>
<short value="Length in seconds (audio / video)"/>
<definition
value="The duration of the recording in seconds - for audio and video."/>
<comment
value="The duration might differ from occurrencePeriod if recording was paused."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Media.duration"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="decimal"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map
value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN",code="<CODE>"].value"/>
</mapping>
<mapping>
<identity value="dicom"/>
<map value="~0028,0002"/>
</mapping>
</element>
<element id="Media.content">
<path value="Media.content"/>
<short value="Actual Media - reference or data"/>
<definition
value="The actual content of the media - inline or by direct reference to the media source file."/>
<comment
value="Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter. For media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Media.content"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="Attachment"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value=".text"/>
</mapping>
</element>
<element id="Media.note">
<path value="Media.note"/>
<short value="Comments made about the media"/>
<definition
value="Comments made about the media by the performer, subject or other participants."/>
<comment
value="Not to be used for observations, conclusions, etc. Instead use an [Observation](http://hl7.org/fhir/R4/observation.html) based on the Media/ImagingStudy resource."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Media.note"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Annotation"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Event.note"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="NTE"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value=".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"/>
</mapping>
</element>
</snapshot>
<differential>
<element id="Media">
<path value="Media"/>
</element>
</differential>
</StructureDefinition>
IG © 2022+ MITRE. Package StandardPatientHealthRecordIG#0.4.4 based on FHIR 4.0.1. Generated 2023-09-13
Links: Table of Contents |
QA Report