NCPI FHIR Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Data Type Profile: DRS Attachment
| Official URL: https://ncpi-fhir.github.io/ncpi-fhir-ig/StructureDefinition/ncpi-drs-attachment | Version: 0.1.0 | |||
| Draft as of 2022-08-16 | Computable Name: DRSAttachment | |||
A FHIR Attachment with a DRS url.
Usage:
- Use this DataType Constraint: DRS Document Reference, Research Document Reference
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Attachment
This structure is derived from Attachment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Attachment | I | 0..* | Attachment | Content in a format defined elsewhere must-be-drs-uri: attachment.url must start with ^drs://. A drs:// hostname-based URI, as defined in the DRS documentation, that tells clients how to access this object. The intent of this field is to make DRS objects self-contained, and therefore easier for clients to store and pass around. For example, if you arrive at this DRS JSON by resolving a compact identifier-based DRS URI, the `self_uri` presents you with a hostname and properly encoded DRS ID for use in subsequent `access` endpoint calls. |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Attachment | I | 0..* | Attachment | Content in a format defined elsewhere must-be-drs-uri: attachment.url must start with ^drs://. A drs:// hostname-based URI, as defined in the DRS documentation, that tells clients how to access this object. The intent of this field is to make DRS objects self-contained, and therefore easier for clients to store and pass around. For example, if you arrive at this DRS JSON by resolving a compact identifier-based DRS URI, the `self_uri` presents you with a hostname and properly encoded DRS ID for use in subsequent `access` endpoint calls. | ||||
  id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | 0..1 | base64Binary | Data inline, base64ed | |||||
| url | Σ | 0..1 | url | Uri where the data can be found 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 | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Attachment | I | 0..* | Attachment | Content in a format defined elsewhere must-be-drs-uri: attachment.url must start with ^drs://. A drs:// hostname-based URI, as defined in the DRS documentation, that tells clients how to access this object. The intent of this field is to make DRS objects self-contained, and therefore easier for clients to store and pass around. For example, if you arrive at this DRS JSON by resolving a compact identifier-based DRS URI, the `self_uri` presents you with a hostname and properly encoded DRS ID for use in subsequent `access` endpoint calls. |
| Documentation for this format | ||||
This structure is derived from Attachment
Differential View
This structure is derived from Attachment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Attachment | I | 0..* | Attachment | Content in a format defined elsewhere must-be-drs-uri: attachment.url must start with ^drs://. A drs:// hostname-based URI, as defined in the DRS documentation, that tells clients how to access this object. The intent of this field is to make DRS objects self-contained, and therefore easier for clients to store and pass around. For example, if you arrive at this DRS JSON by resolving a compact identifier-based DRS URI, the `self_uri` presents you with a hostname and properly encoded DRS ID for use in subsequent `access` endpoint calls. |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Attachment | I | 0..* | Attachment | Content in a format defined elsewhere must-be-drs-uri: attachment.url must start with ^drs://. A drs:// hostname-based URI, as defined in the DRS documentation, that tells clients how to access this object. The intent of this field is to make DRS objects self-contained, and therefore easier for clients to store and pass around. For example, if you arrive at this DRS JSON by resolving a compact identifier-based DRS URI, the `self_uri` presents you with a hostname and properly encoded DRS ID for use in subsequent `access` endpoint calls. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | 0..1 | base64Binary | Data inline, base64ed | |||||
| url | Σ | 0..1 | url | Uri where the data can be found 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: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| Attachment.contentType | required | Mime Types |
| Attachment.language | preferred | CommonLanguages Max Binding: AllLanguages |
Constraints
| Id | Grade | Path | Details | Requirements |
| att-1 | error | Attachment | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
| ele-1 | error | Attachment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| must-be-drs-uri | error | Attachment | attachment.url must start with ^drs://. A drs:// hostname-based URI, as defined in the DRS documentation, that tells clients how to access this object. The intent of this field is to make DRS objects self-contained, and therefore easier for clients to store and pass around. For example, if you arrive at this DRS JSON by resolving a compact identifier-based DRS URI, the `self_uri` presents you with a hostname and properly encoded DRS ID for use in subsequent `access` endpoint calls. : $this.url.matches('^drs://.*') | |
| ele-1 | error | Attachment.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Attachment.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Attachment.contentType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Attachment.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Attachment.data | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Attachment.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Attachment.size | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Attachment.hash | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Attachment.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Attachment.creation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |