Mit dem Profil MII PR Patho Attached Image der Ressource Media wird die Beschreibung von in den Befund, d.h. den MII PR Patho Report, eingebetteten Bildern vorgenommen. Um Bilder in MII PR Patho Finding einzubinden, muss auf eine Referenz zu einer ImagingStudy zurückgegriffen werden. Das vorliegende Profil sollte vorzugsweise nur zur "Illustration" eines Pathologiebefundberichts verwendet werden.
Name | Canonical |
---|---|
MII_PR_Patho_Attached_Image | https://www.medizininformatik-initiative.de/fhir/ext/modul-patho/StructureDefinition/mii-pr-patho-attached-image |
MII_PR_Patho_Attached_Image (Media) | I | Media | There are no (further) constraints on this element Element idMedia A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference DefinitionA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
| |
id | S Σ | 0..1 | string | There are no (further) constraints on this element Element idMedia.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idMedia.meta Metadata about the resource DefinitionThe 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idMedia.meta.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMedia.meta.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idMedia.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | S Σ | 0..1 | instant | There are no (further) constraints on this element Element idMedia.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idMedia.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | S Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element idMedia.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) Constraints
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idMedia.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System.
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idMedia.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idMedia.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedia.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | S | 0..1 | Narrative | There are no (further) constraints on this element Element idMedia.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idMedia.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMedia.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idMedia.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idMedia.identifier Identifier(s) for the image DefinitionIdentifiers 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. The identifier label and use can be used to determine what kind of identifier it is.
|
basedOn | Σ I | 0..* | Reference(ServiceRequest | CarePlan) | There are no (further) constraints on this element Element idMedia.basedOn Procedure that caused this media to be created Alternate namesfulfills DefinitionA procedure that is fulfilled in whole or in part by the creation of this media. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ServiceRequest | CarePlan) Constraints
|
partOf | S Σ I | 0..* | Reference(Media) | Element idMedia.partOf Part of referenced event Alternate namescontainer DefinitionA larger event of which this particular event is a component or step. E.g. Drug administration as part of a procedure, procedure as part of observation, etc. 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].
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idMedia.status preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown DefinitionThe current state of the {{title}}. 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. Codes identifying the lifecycle stage of an event.
|
type | S Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedia.type Classification of media as image, video, or audio DefinitionA code that classifies whether the media is an image, video or audio recording or some other media category. Used for filtering what observations are retrieved and displayed. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes for high level media categories.
|
id | 0..1 | string | There are no (further) constraints on this element Element idMedia.type.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMedia.type.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | Element idMedia.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Value) Constraints
|
image | Σ | 1..1 | CodingPattern | Element idMedia.type.coding:image Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://terminology.hl7.org/CodeSystem/media-type", "code": "image" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedia.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
modality | S Σ | 0..1 | CodeableConceptBinding | Element idMedia.modality The type of acquisition equipment/process DefinitionDetails 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it.
|
view | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedia.view Imaging view, e.g. Lateral or Antero-posterior DefinitionThe name of the imaging view e.g. Lateral or Antero-posterior (AP). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Imaging view (projection) used when collecting an image.
|
subject | S Σ I | 0..1 | Reference(MII_PR_Patho_Specimen) | Element idMedia.subject Who/What this Media is a record of DefinitionWho/What this Media is a record of. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(MII_PR_Patho_Specimen) Constraints
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idMedia.encounter Encounter associated with media Alternate namescontext DefinitionThe encounter that establishes the context for this media. Links the Media to the Encounter context. This will typically be the encounter the media occurred within.
|
created[x] | Σ | 0..1 | There are no (further) constraints on this element Element idMedia.created[x] When Media was collected Alternate namestiming DefinitionThe date and time(s) at which the media was collected.
| |
createdDateTime | dateTime | There are no (further) constraints on this element Data type | ||
createdPeriod | Period | There are no (further) constraints on this element Data type | ||
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element idMedia.issued Date/Time this version was made available DefinitionThe date and time this version of the media was made available to providers, typically after having been reviewed. It may be the same as the
|
operator | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | There are no (further) constraints on this element Element idMedia.operator The person who generated the image DefinitionThe person who administered the collection of the image. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Constraints
|
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idMedia.reasonCode Why was event performed? DefinitionDescribes why the event occurred in coded or textual form. Textual reasons can be captured using reasonCode.text. The reason for the media.
|
bodySite | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedia.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). 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. Codes describing anatomical locations. May include laterality.
|
deviceName | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedia.deviceName Name of the device/manufacturer DefinitionThe name of the device / manufacturer of the device that was used to make the recording. Note that FHIR strings SHALL NOT exceed 1MB in size
|
device | Σ I | 0..1 | Reference(Device | DeviceMetric | Device) | There are no (further) constraints on this element Element idMedia.device Observing Device DefinitionThe device used to collect the media. 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. Reference(Device | DeviceMetric | Device) Constraints
|
height | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedia.height Height of the image in pixels (photo/video) DefinitionHeight of the image in pixels (photo/video). 32 bit number; for values larger than this, use decimal
|
width | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedia.width Width of the image in pixels (photo/video) DefinitionWidth of the image in pixels (photo/video). 32 bit number; for values larger than this, use decimal
|
frames | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedia.frames Number of frames if > 1 (photo) DefinitionThe 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. 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.
|
duration | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idMedia.duration Length in seconds (audio / video) DefinitionThe duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.
|
content | S Σ I | 1..1 | Attachment | There are no (further) constraints on this element Element idMedia.content Actual Media - reference or data DefinitionThe actual content of the media - inline or by direct reference to the media source file. 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.
|
note | 0..* | Annotation | There are no (further) constraints on this element Element idMedia.note Comments made about the media DefinitionComments made about the media by the performer, subject or other participants. Not to be used for observations, conclusions, etc. Instead use an Observation based on the Media/ImagingStudy resource.
|
MII_PR_Patho_Attached_Image (Media) | I | Media | There are no (further) constraints on this element Element idMedia A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference DefinitionA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
| |
id | S Σ | 0..1 | string | There are no (further) constraints on this element Element idMedia.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idMedia.meta Metadata about the resource DefinitionThe 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idMedia.meta.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMedia.meta.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idMedia.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | S Σ | 0..1 | instant | There are no (further) constraints on this element Element idMedia.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idMedia.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | S Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element idMedia.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) Constraints
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idMedia.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System.
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idMedia.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idMedia.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedia.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | S | 0..1 | Narrative | There are no (further) constraints on this element Element idMedia.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idMedia.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMedia.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idMedia.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idMedia.identifier Identifier(s) for the image DefinitionIdentifiers 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. The identifier label and use can be used to determine what kind of identifier it is.
|
basedOn | Σ I | 0..* | Reference(ServiceRequest | CarePlan) | There are no (further) constraints on this element Element idMedia.basedOn Procedure that caused this media to be created Alternate namesfulfills DefinitionA procedure that is fulfilled in whole or in part by the creation of this media. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ServiceRequest | CarePlan) Constraints
|
partOf | S Σ I | 0..* | Reference(Media) | Element idMedia.partOf Part of referenced event Alternate namescontainer DefinitionA larger event of which this particular event is a component or step. E.g. Drug administration as part of a procedure, procedure as part of observation, etc. 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].
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idMedia.status preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown DefinitionThe current state of the {{title}}. 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. Codes identifying the lifecycle stage of an event.
|
type | S Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedia.type Classification of media as image, video, or audio DefinitionA code that classifies whether the media is an image, video or audio recording or some other media category. Used for filtering what observations are retrieved and displayed. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes for high level media categories.
|
id | 0..1 | string | There are no (further) constraints on this element Element idMedia.type.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMedia.type.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | Element idMedia.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Value) Constraints
|
image | Σ | 1..1 | CodingPattern | Element idMedia.type.coding:image Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://terminology.hl7.org/CodeSystem/media-type", "code": "image" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedia.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
modality | S Σ | 0..1 | CodeableConceptBinding | Element idMedia.modality The type of acquisition equipment/process DefinitionDetails 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it.
|
view | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedia.view Imaging view, e.g. Lateral or Antero-posterior DefinitionThe name of the imaging view e.g. Lateral or Antero-posterior (AP). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Imaging view (projection) used when collecting an image.
|
subject | S Σ I | 0..1 | Reference(MII_PR_Patho_Specimen) | Element idMedia.subject Who/What this Media is a record of DefinitionWho/What this Media is a record of. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(MII_PR_Patho_Specimen) Constraints
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idMedia.encounter Encounter associated with media Alternate namescontext DefinitionThe encounter that establishes the context for this media. Links the Media to the Encounter context. This will typically be the encounter the media occurred within.
|
created[x] | Σ | 0..1 | There are no (further) constraints on this element Element idMedia.created[x] When Media was collected Alternate namestiming DefinitionThe date and time(s) at which the media was collected.
| |
createdDateTime | dateTime | There are no (further) constraints on this element Data type | ||
createdPeriod | Period | There are no (further) constraints on this element Data type | ||
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element idMedia.issued Date/Time this version was made available DefinitionThe date and time this version of the media was made available to providers, typically after having been reviewed. It may be the same as the
|
operator | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | There are no (further) constraints on this element Element idMedia.operator The person who generated the image DefinitionThe person who administered the collection of the image. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Constraints
|
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idMedia.reasonCode Why was event performed? DefinitionDescribes why the event occurred in coded or textual form. Textual reasons can be captured using reasonCode.text. The reason for the media.
|
bodySite | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedia.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). 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. Codes describing anatomical locations. May include laterality.
|
deviceName | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedia.deviceName Name of the device/manufacturer DefinitionThe name of the device / manufacturer of the device that was used to make the recording. Note that FHIR strings SHALL NOT exceed 1MB in size
|
device | Σ I | 0..1 | Reference(Device | DeviceMetric | Device) | There are no (further) constraints on this element Element idMedia.device Observing Device DefinitionThe device used to collect the media. 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. Reference(Device | DeviceMetric | Device) Constraints
|
height | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedia.height Height of the image in pixels (photo/video) DefinitionHeight of the image in pixels (photo/video). 32 bit number; for values larger than this, use decimal
|
width | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedia.width Width of the image in pixels (photo/video) DefinitionWidth of the image in pixels (photo/video). 32 bit number; for values larger than this, use decimal
|
frames | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedia.frames Number of frames if > 1 (photo) DefinitionThe 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. 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.
|
duration | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idMedia.duration Length in seconds (audio / video) DefinitionThe duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.
|
content | S Σ I | 1..1 | Attachment | There are no (further) constraints on this element Element idMedia.content Actual Media - reference or data DefinitionThe actual content of the media - inline or by direct reference to the media source file. 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.
|
note | 0..* | Annotation | There are no (further) constraints on this element Element idMedia.note Comments made about the media DefinitionComments made about the media by the performer, subject or other participants. Not to be used for observations, conclusions, etc. Instead use an Observation based on the Media/ImagingStudy resource.
|
MII_PR_Patho_Attached_Image (Media) | I | Media | There are no (further) constraints on this element Element idMedia A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference DefinitionA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
| |
id | S Σ | 0..1 | string | There are no (further) constraints on this element Element idMedia.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idMedia.meta Metadata about the resource DefinitionThe 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idMedia.meta.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMedia.meta.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idMedia.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | S Σ | 0..1 | instant | There are no (further) constraints on this element Element idMedia.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idMedia.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | S Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element idMedia.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) Constraints
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idMedia.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System.
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idMedia.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idMedia.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedia.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | S | 0..1 | Narrative | There are no (further) constraints on this element Element idMedia.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idMedia.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMedia.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idMedia.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idMedia.identifier Identifier(s) for the image DefinitionIdentifiers 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. The identifier label and use can be used to determine what kind of identifier it is.
|
basedOn | Σ I | 0..* | Reference(ServiceRequest | CarePlan) | There are no (further) constraints on this element Element idMedia.basedOn Procedure that caused this media to be created Alternate namesfulfills DefinitionA procedure that is fulfilled in whole or in part by the creation of this media. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ServiceRequest | CarePlan) Constraints
|
partOf | S Σ I | 0..* | Reference(Media) | Element idMedia.partOf Part of referenced event Alternate namescontainer DefinitionA larger event of which this particular event is a component or step. E.g. Drug administration as part of a procedure, procedure as part of observation, etc. 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].
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idMedia.status preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown DefinitionThe current state of the {{title}}. 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. Codes identifying the lifecycle stage of an event.
|
type | S Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedia.type Classification of media as image, video, or audio DefinitionA code that classifies whether the media is an image, video or audio recording or some other media category. Used for filtering what observations are retrieved and displayed. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes for high level media categories.
|
id | 0..1 | string | There are no (further) constraints on this element Element idMedia.type.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMedia.type.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | Element idMedia.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Value) Constraints
|
image | Σ | 1..1 | CodingPattern | Element idMedia.type.coding:image Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://terminology.hl7.org/CodeSystem/media-type", "code": "image" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedia.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
modality | S Σ | 0..1 | CodeableConceptBinding | Element idMedia.modality The type of acquisition equipment/process DefinitionDetails 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it.
|
view | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedia.view Imaging view, e.g. Lateral or Antero-posterior DefinitionThe name of the imaging view e.g. Lateral or Antero-posterior (AP). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Imaging view (projection) used when collecting an image.
|
subject | S Σ I | 0..1 | Reference(MII_PR_Patho_Specimen) | Element idMedia.subject Who/What this Media is a record of DefinitionWho/What this Media is a record of. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(MII_PR_Patho_Specimen) Constraints
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idMedia.encounter Encounter associated with media Alternate namescontext DefinitionThe encounter that establishes the context for this media. Links the Media to the Encounter context. This will typically be the encounter the media occurred within.
|
created[x] | Σ | 0..1 | There are no (further) constraints on this element Element idMedia.created[x] When Media was collected Alternate namestiming DefinitionThe date and time(s) at which the media was collected.
| |
createdDateTime | dateTime | There are no (further) constraints on this element Data type | ||
createdPeriod | Period | There are no (further) constraints on this element Data type | ||
issued | Σ | 0..1 | instant | There are no (further) constraints on this element Element idMedia.issued Date/Time this version was made available DefinitionThe date and time this version of the media was made available to providers, typically after having been reviewed. It may be the same as the
|
operator | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | There are no (further) constraints on this element Element idMedia.operator The person who generated the image DefinitionThe person who administered the collection of the image. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Constraints
|
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idMedia.reasonCode Why was event performed? DefinitionDescribes why the event occurred in coded or textual form. Textual reasons can be captured using reasonCode.text. The reason for the media.
|
bodySite | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedia.bodySite Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). 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. Codes describing anatomical locations. May include laterality.
|
deviceName | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedia.deviceName Name of the device/manufacturer DefinitionThe name of the device / manufacturer of the device that was used to make the recording. Note that FHIR strings SHALL NOT exceed 1MB in size
|
device | Σ I | 0..1 | Reference(Device | DeviceMetric | Device) | There are no (further) constraints on this element Element idMedia.device Observing Device DefinitionThe device used to collect the media. 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. Reference(Device | DeviceMetric | Device) Constraints
|
height | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedia.height Height of the image in pixels (photo/video) DefinitionHeight of the image in pixels (photo/video). 32 bit number; for values larger than this, use decimal
|
width | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedia.width Width of the image in pixels (photo/video) DefinitionWidth of the image in pixels (photo/video). 32 bit number; for values larger than this, use decimal
|
frames | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedia.frames Number of frames if > 1 (photo) DefinitionThe 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. 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.
|
duration | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idMedia.duration Length in seconds (audio / video) DefinitionThe duration of the recording in seconds - for audio and video. The duration might differ from occurrencePeriod if recording was paused.
|
content | S Σ I | 1..1 | Attachment | There are no (further) constraints on this element Element idMedia.content Actual Media - reference or data DefinitionThe actual content of the media - inline or by direct reference to the media source file. 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.
|
note | 0..* | Annotation | There are no (further) constraints on this element Element idMedia.note Comments made about the media DefinitionComments made about the media by the performer, subject or other participants. Not to be used for observations, conclusions, etc. Instead use an Observation based on the Media/ImagingStudy resource.
|
{ "resourceType": "StructureDefinition", "id": "mii-pr-patho-attached-image", "url": "https://www.medizininformatik-initiative.de/fhir/ext/modul-patho/StructureDefinition/mii-pr-patho-attached-image", "version": "1.0.0", "name": "MII_PR_Patho_Attached_Image", "title": "MII PR Patho Attached Image", "status": "active", "publisher": "Medizininformatik Initiative", "contact": [ { "telecom": [ { "system": "url", "value": "https://www.medizininformatik-initiative.de" } ] } ], "description": "Profile for attached images", "fhirVersion": "4.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" }, { "identity": "dicom", "uri": "http://nema.org/dicom", "name": "DICOM Tag Mapping" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "sct-concept", "uri": "http://snomed.info/conceptdomain", "name": "SNOMED CT Concept Domain Binding" }, { "identity": "sct-attr", "uri": "http://snomed.org/attributebinding", "name": "SNOMED CT Attribute Binding" } ], "kind": "resource", "abstract": false, "type": "Media", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Media", "derivation": "constraint", "differential": { "element": [ { "id": "Media.id", "path": "Media.id", "mustSupport": true }, { "id": "Media.meta.lastUpdated", "path": "Media.meta.lastUpdated", "mustSupport": true }, { "id": "Media.meta.profile", "path": "Media.meta.profile", "mustSupport": true }, { "id": "Media.text", "path": "Media.text", "mustSupport": true }, { "id": "Media.partOf", "path": "Media.partOf", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Media" ] } ], "mustSupport": true }, { "id": "Media.status", "path": "Media.status", "mustSupport": true }, { "id": "Media.type", "path": "Media.type", "min": 1, "mustSupport": true }, { "id": "Media.type.coding", "path": "Media.type.coding", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" }, "min": 1 }, { "id": "Media.type.coding:image", "path": "Media.type.coding", "sliceName": "image", "min": 1, "max": "1", "patternCoding": { "code": "image", "system": "http://terminology.hl7.org/CodeSystem/media-type" } }, { "id": "Media.modality", "path": "Media.modality", "mustSupport": true, "binding": { "strength": "extensible", "valueSet": "https://www.medizininformatik-initiative.de/fhir/ext/modul-patho/ValueSet/mii-vs-patho-media-modality-snomed-ct" } }, { "id": "Media.subject", "path": "Media.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://www.medizininformatik-initiative.de/fhir/ext/modul-patho/StructureDefinition/mii-pr-patho-specimen" ] } ], "mustSupport": true }, { "id": "Media.content", "path": "Media.content", "mustSupport": true } ] } }
FHIR-Element | Erklärung |
---|---|
Media.id | Must-Support, jedoch optional |
Media.meta.lastUpdated | Must-Support, jedoch optional |
Media.meta.profile | Must-Support, jedoch optional |
Media.partOf | Referenz auf Medium |
Media.status | Eventstatus |
Media.text | textliche Beschreibung der Aufnahme |
Media.type | Medientyp (Image) |
Media.subject | Referenz auf Probe |
Media.content | Medien-Anhang |
FHIR-Element | Logisches Datenmodell |
---|---|
Media.id | EingebettetesBild.ID |
Media.partOf | Media |
Media.status | EingebettetesBild.Status |
Media.type | EingebettetesBild.Typ |
Media.subject | Probe |
Media.content | EingebettetesBild.Kontent |
Folgende Suchparameter sind für das Modul Pathologie-Befund relevant, auch in Kombination:
Der Suchparameter _id
MUSS unterstützt werden:
Beispiele:
GET [base]/Media?_id=103270
Anwendungshinweise: Weitere Informationen zur Suche nach _id
finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".
Der Suchparameter _lastUpdated
MUSS unterstützt werden:
Beispiele:
GET [base]/Media?_lastUpdated=2021-12-08
Anwendungshinweise: Weitere Informationen zur Suche nach _lastUpdated
finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".
Der Suchparameter _profile
MUSS unterstützt werden:
Beispiele:
GET [base]/Media?_profile=https://www.medizininformatik-initiative.de/fhir/ext/modul-patho/StructureDefinition/mii-pr-patho-attached-image
Anwendungshinweise: Weitere Informationen zur Suche nach _profile
finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".
Der Suchparameter created
MUSS unterstützt werden:
Beispiele:
GET [base]/Media?created=2021-06-08
Anwendungshinweise: Weitere Informationen zur Suche nach Media.created
finden sich in der FHIR-Basisspezifikation - Abschnitt "date".
Der Suchparameter status
MUSS unterstützt werden:
Beispiele:
GET [base]/Media?status=completed
Anwendungshinweise: Weitere Informationen zur Suche nach Media.status
finden sich in der FHIR-Basisspezifikation - Abschnitt "token".
Der Suchparameter subject
MUSS unterstützt werden:
Beispiele:
GET [base]/Media?subject=Specimen/ex-mii-patho-prostate-tru-cut-biopsy-sample
Anwendungshinweise: Weitere Informationen zur Suche nach Media.subject
finden sich in der FHIR-Basisspezifikation - Abschnitt "reference".
Der Suchparameter type
MUSS unterstützt werden:
Beispiele:
GET [base]/Media?type=image
GET [base]/Media?type=http://terminology.hl7.org/CodeSystem/media-type|image
Anwendungshinweise: Weitere Informationen zur Suche nach Media.type
finden sich in der FHIR-Basisspezifikation - Abschnitt "token".
Der Suchparameter part-of
MUSS unterstützt werden:
Beispiele:
GET [base]/Media?part-of=Media/9878097
Anwendungshinweise: Weitere Informationen zur Suche nach (Media.partOf as Media)
finden sich in der FHIR-Basisspezifikation - Abschnitt "reference".
{ "resourceType": "Media", "id": "mii-exa-patho-attached-image", "meta": { "profile": [ "https://www.medizininformatik-initiative.de/fhir/ext/modul-patho/StructureDefinition/mii-pr-patho-attached-image" ] }, "type": { "coding": [ { "code": "image", "system": "http://terminology.hl7.org/CodeSystem/media-type" } ] }, "status": "completed", "subject": { "reference": "Specimen/mii-exa-patho-prostate-tru-cut-biopsy-sample" }, "content": { "contentType": "image/png", "url": "https://pathologie.klinikum-karlsruhe.de/fhir/fn/image" } }
Powered by SIMPLIFIER.NET