Nationella informationsmängder - Local Development build (v0.1). See the Directory of published versions
Resource Profile: Bildresurs
| Defining URL: | https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/NIMImageResource |
| Version: | 0.1 |
| Name: | NIMImageResource |
| Title: | Bildresurs |
| Status: | Active as of 2021-03-30T19:36:18+02:00 |
| Publisher: | Socialstyrelsen |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/NIMImageResource
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Media
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
  identifier | S | 0..* | Identifier | Identifier(s) for the image |
| status | S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
 type | 0..1 | CodeableConcept | Classification of media as image, video, or audio Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
  code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: image | |
| note | S | 0..* | Annotation | Comments made about the media |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | Identifier | Identifier(s) for the image |
 basedOn | Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created |
| partOf | Σ | 0..* | Reference(Resource) | Part of referenced event |
| status | ?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. |
| type | Σ | 0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 0..1 | uri | Identity of the terminology system | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: image | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| modality | Σ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. |
| view | Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. |
| subject | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) | Who/What this Media is a record of |
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with media |
 created[x] | Σ | 0..1 | When Media was collected | |
| createdDateTime | dateTime | |||
| createdPeriod | Period | |||
| issued | Σ | 0..1 | instant | Date/Time this version was made available |
| operator | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image |
| reasonCode | Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. |
| bodySite | Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| deviceName | Σ | 0..1 | string | Name of the device/manufacturer |
| device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device |
| height | Σ | 0..1 | positiveInt | Height of the image in pixels (photo/video) |
| width | Σ | 0..1 | positiveInt | Width of the image in pixels (photo/video) |
| frames | Σ | 0..1 | positiveInt | Number of frames if > 1 (photo) |
| duration | Σ | 0..1 | decimal | Length in seconds (audio / video) |
| content | Σ | 1..1 | Attachment | Actual Media - reference or data |
| note | S | 0..* | Annotation | Comments made about the media |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
| identifier | Σ | 0..* | Identifier | Identifier(s) for the image |
| status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. |
| note | 0..* | Annotation | Comments made about the media | |
| Documentation for this format | ||||
This structure is derived from Media
Differential View
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
| identifier | S | 0..* | Identifier | Identifier(s) for the image |
| status | S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
| type | 0..1 | CodeableConcept | Classification of media as image, video, or audio Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: image | |
| note | S | 0..* | Annotation | Comments made about the media |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | Identifier | Identifier(s) for the image |
| basedOn | Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created |
| partOf | Σ | 0..* | Reference(Resource) | Part of referenced event |
| status | ?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. |
| type | Σ | 0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 0..1 | uri | Identity of the terminology system | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: image | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| modality | Σ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. |
| view | Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. |
| subject | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) | Who/What this Media is a record of |
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter associated with media |
| created[x] | Σ | 0..1 | When Media was collected | |
| createdDateTime | dateTime | |||
| createdPeriod | Period | |||
| issued | Σ | 0..1 | instant | Date/Time this version was made available |
| operator | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image |
| reasonCode | Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. |
| bodySite | Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| deviceName | Σ | 0..1 | string | Name of the device/manufacturer |
| device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device |
| height | Σ | 0..1 | positiveInt | Height of the image in pixels (photo/video) |
| width | Σ | 0..1 | positiveInt | Width of the image in pixels (photo/video) |
| frames | Σ | 0..1 | positiveInt | Number of frames if > 1 (photo) |
| duration | Σ | 0..1 | decimal | Length in seconds (audio / video) |
| content | Σ | 1..1 | Attachment | Actual Media - reference or data |
| note | S | 0..* | Annotation | Comments made about the media |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| Media.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Media.status | required | EventStatus |
| Media.type | extensible | Pattern: image |
| Media.modality | example | MediaModality |
| Media.view | example | MediaCollectionView/Projection |
| Media.reasonCode | example | ProcedureReasonCodes |
| Media.bodySite | example | SNOMEDCTBodyStructures |
Constraints
| Id | Path | Details | Requirements |
| dom-2 | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | Media | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | Media | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Media | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Media.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Media.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Media.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Media.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Media.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.modality | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.view | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.created[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.issued | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.operator | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.bodySite | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.deviceName | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.device | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.height | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.width | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.frames | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.duration | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.content | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Media.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |