3.43 StructureDefinition: Shared Health Media Fax
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/profile-media-fax
3.43.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from Media
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Media | 0..* | mda-1: Height can only be used for a photo or video mda-2: Width can only be used for a photo or video mda-4: Duration can only be used for an audio or a video mda-3: Frames can only be used for a photo Definition: A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference. Comments: Media is used to provide a copy of the Fax document that was created. Subtype and content are both mandatory. All values for subtype are fixed values. Content will be sued to provide the url where the copy of the Fax document can be retrieved. | |
 id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the sending application. Ideally it should be consistent for all messages referencing this same set of coverage information. |
| type | 1..1 | code | Binding: DigitalMediaType (required) Fixed Value: photo Definition: Whether the media is a photo (still image), an audio recording, or a video recording. Comments: Fixed value: photo |
| subtype | 1..1 | Shared Health CodeableConcept Code | Binding: Media SubType (example) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: |
 content | 1..1 | Attachment | Definition: The actual content of the media - inline or by direct reference to the media source file. Comments: 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 an 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. |
 contentType | 1..1 | code | Binding: mimetypes (required) Fixed Value: application/pdf Definition: Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. Comments: Fixed value: application/pdf |
| url | 1..1 | uri | Example' General': http://www.acme.com/logo-small.png Definition: This is the URL from which the message recipient can retrieve the fax that was sent to the target of the underliverable message Comments: A url will be provided, where the Fax document can be retrieved from. |
This structure is derived from Media
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Media | S | 0..* | ||
| id | S | 1..1 | id | |
| type | S | 1..1 | code | Fixed Value: photo |
 subtype | S | 1..1 | Shared Health CodeableConcept Code | |
| content | S | 1..1 | Attachment | |
| contentType | S | 1..1 | code | Fixed Value: application/pdf |
| data | 0..0 | |||
| url | S | 1..1 | uri | URL to retrieve fax from |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | SI | 0..* | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
 id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
| text | I | 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 | Σ | 0..* | Identifier | Identifier(s) for the image |
| type | SΣ | 1..1 | code | photo | video | audio Binding: DigitalMediaType (required) Fixed Value: photo |
| subtype | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: Media SubType (example) |
| view | Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: Media Collection View/Projection (example) |
 subject | Σ | 0..1 | Reference(Patient | Practitioner | Group | Device | Specimen) | Who/What this Media is a record of |
| operator | Σ | 0..1 | Reference(Practitioner) | The person who generated the image |
| deviceName | Σ | 0..1 | string | Name of the device/manufacturer |
| height | ΣI | 0..1 | positiveInt | Height of the image in pixels (photo/video) |
| width | ΣI | 0..1 | positiveInt | Width of the image in pixels (photo/video) |
| frames | ΣI | 0..1 | positiveInt | Number of frames if > 1 (photo) |
| duration | ΣI | 0..1 | unsignedInt | Length in seconds (audio / video) |
| content | S | 1..1 | Attachment | Actual Media - reference or data |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| contentType | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: mimetypes (required) Fixed Value: application/pdf |
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: http://tools.ietf.org/html/bcp47 (required) Example General': en-AU |
| url | SΣ | 1..1 | uri | URL to retrieve fax from Example General': http://www.acme.com/logo-small.png |
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | Σ | 0..1 | string | Label to display in place of the data Example General': Official Corporate Logo |
| creation | Σ | 0..1 | dateTime | Date attachment was first created |
| Documentation for this format | ||||
Grid View
This structure is derived from Media
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Media | 0..* | mda-1: Height can only be used for a photo or video mda-2: Width can only be used for a photo or video mda-4: Duration can only be used for an audio or a video mda-3: Frames can only be used for a photo Definition: A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference. Comments: Media is used to provide a copy of the Fax document that was created. Subtype and content are both mandatory. All values for subtype are fixed values. Content will be sued to provide the url where the copy of the Fax document can be retrieved. | |
| id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the sending application. Ideally it should be consistent for all messages referencing this same set of coverage information. |
| type | 1..1 | code | Binding: DigitalMediaType (required) Fixed Value: photo Definition: Whether the media is a photo (still image), an audio recording, or a video recording. Comments: Fixed value: photo |
| subtype | 1..1 | Shared Health CodeableConcept Code | Binding: Media SubType (example) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: |
| content | 1..1 | Attachment | Definition: The actual content of the media - inline or by direct reference to the media source file. Comments: 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 an 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. |
| contentType | 1..1 | code | Binding: mimetypes (required) Fixed Value: application/pdf Definition: Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. Comments: Fixed value: application/pdf |
| url | 1..1 | uri | Example' General': http://www.acme.com/logo-small.png Definition: This is the URL from which the message recipient can retrieve the fax that was sent to the target of the underliverable message Comments: A url will be provided, where the Fax document can be retrieved from. |
This structure is derived from Media
Differential View
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | S | 0..* | ||
| id | S | 1..1 | id | |
| type | S | 1..1 | code | Fixed Value: photo |
| subtype | S | 1..1 | Shared Health CodeableConcept Code | |
| content | S | 1..1 | Attachment | |
| contentType | S | 1..1 | code | Fixed Value: application/pdf |
| data | 0..0 | |||
| url | S | 1..1 | uri | URL to retrieve fax from |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | SI | 0..* | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
| id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
| text | I | 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 | Σ | 0..* | Identifier | Identifier(s) for the image |
| type | SΣ | 1..1 | code | photo | video | audio Binding: DigitalMediaType (required) Fixed Value: photo |
| subtype | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: Media SubType (example) |
| view | Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: Media Collection View/Projection (example) |
| subject | Σ | 0..1 | Reference(Patient | Practitioner | Group | Device | Specimen) | Who/What this Media is a record of |
| operator | Σ | 0..1 | Reference(Practitioner) | The person who generated the image |
| deviceName | Σ | 0..1 | string | Name of the device/manufacturer |
| height | ΣI | 0..1 | positiveInt | Height of the image in pixels (photo/video) |
| width | ΣI | 0..1 | positiveInt | Width of the image in pixels (photo/video) |
| frames | ΣI | 0..1 | positiveInt | Number of frames if > 1 (photo) |
| duration | ΣI | 0..1 | unsignedInt | Length in seconds (audio / video) |
| content | S | 1..1 | Attachment | Actual Media - reference or data |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| contentType | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: mimetypes (required) Fixed Value: application/pdf |
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: http://tools.ietf.org/html/bcp47 (required) Example General': en-AU |
| url | SΣ | 1..1 | uri | URL to retrieve fax from Example General': http://www.acme.com/logo-small.png |
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | Σ | 0..1 | string | Label to display in place of the data Example General': Official Corporate Logo |
| creation | Σ | 0..1 | dateTime | Date attachment was first created |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.43.3 Terminology Bindings
Terminology Bindings
| Path | Name | Conformance | ValueSet |
| Media.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| Media.type | DigitalMediaType | required | DigitalMediaType |
| Media.subtype | Media SubType | example | Media SubType |
| Media.view | Media Collection View/Projection | example | Media Collection View/Projection |
| Media.content.contentType | ?ext | required | http://hl7.org/fhir/ValueSet/mimetypes |
| Media.content.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
3.43.4 Constraints
Constraints
| Id | Path | Details | Requirements |
| mda-1 | Media | Height can only be used for a photo or video : height.empty() or type != 'audio' | |
| mda-2 | Media | Width can only be used for a photo or video : width.empty() or type != 'audio' | |
| mda-4 | Media | Duration can only be used for an audio or a video : duration.empty() or type != 'photo' | |
| mda-3 | Media | Frames can only be used for a photo : frames.empty() or type = 'photo' |