STU 3 Candidate
This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
Logical Model V3 Data type ED (EncapsulatedData)
{
"resourceType": "StructureDefinition",
"id": "ED",
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace",
"valueUri": "urn:hl7-org:v3"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/ED",
"name": "V3 Data type ED (EncapsulatedData)",
"display": "V3 Data type ED (EncapsulatedData)",
"status": "active",
"experimental": false,
"publisher": "HL7",
"description": "Data that is primarily intended for human interpretation or for further machine processing outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information in as defined by a different standard (e.g., XML-signatures.) Instead of the data itself, an may contain only a reference (see .) Note that the data type is a specialization of the data type when the media type is text/plain.",
"kind": "logical",
"abstract": false,
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/ANY",
"snapshot": {
"element": [
{
"path": "ED",
"min": 1,
"max": "*",
"type": [
{
"code": "Element"
}
]
},
{
"path": "ED.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-NullFlavor"
}
}
},
{
"path": "ED.representation",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ED.data",
"representation": [
"xmlText"
],
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
]
},
{
"path": "ED.mediaType",
"representation": [
"xmlAttr"
],
"label": "Media Type",
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ED.charset",
"representation": [
"xmlAttr"
],
"label": "Charset",
"definition": "For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 [].",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ED.language",
"representation": [
"xmlAttr"
],
"label": "Language",
"definition": "For character based information the language property specifies the human language of the text.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ED.compression",
"representation": [
"xmlAttr"
],
"label": "Compression",
"definition": "Indicates whether the raw byte data is compressed, and what compression algorithm was used.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-CompressionAlgorithm"
}
}
},
{
"path": "ED.reference",
"label": "Reference",
"definition": "A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.",
"min": 0,
"max": "1",
"type": [
{
"code": "TEL"
}
]
},
{
"path": "ED.integrityCheck",
"representation": [
"xmlAttr"
],
"label": "Integrity Check",
"definition": "The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
]
},
{
"path": "ED.integrityCheckAlgorithm",
"representation": [
"xmlAttr"
],
"label": "Integrity Check Algorithm",
"definition": "Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-IntegrityCheckAlgorithm"
}
}
},
{
"path": "ED.thumbnail",
"label": "Thumbnail",
"definition": "An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "ED"
}
]
}
]
},
"differential": {
"element": [
{
"path": "ED",
"min": 1,
"max": "*",
"type": [
{
"code": "Element"
}
]
},
{
"path": "ED.representation",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ED.data",
"representation": [
"xmlText"
],
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
]
},
{
"path": "ED.mediaType",
"representation": [
"xmlAttr"
],
"label": "Media Type",
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ED.charset",
"representation": [
"xmlAttr"
],
"label": "Charset",
"definition": "For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 [].",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ED.language",
"representation": [
"xmlAttr"
],
"label": "Language",
"definition": "For character based information the language property specifies the human language of the text.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ED.compression",
"representation": [
"xmlAttr"
],
"label": "Compression",
"definition": "Indicates whether the raw byte data is compressed, and what compression algorithm was used.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-CompressionAlgorithm"
}
}
},
{
"path": "ED.reference",
"label": "Reference",
"definition": "A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.",
"min": 0,
"max": "1",
"type": [
{
"code": "TEL"
}
]
},
{
"path": "ED.integrityCheck",
"representation": [
"xmlAttr"
],
"label": "Integrity Check",
"definition": "The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
]
},
{
"path": "ED.integrityCheckAlgorithm",
"representation": [
"xmlAttr"
],
"label": "Integrity Check Algorithm",
"definition": "Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-IntegrityCheckAlgorithm"
}
}
},
{
"path": "ED.thumbnail",
"label": "Thumbnail",
"definition": "An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "ED"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Candidate (v1.4.0-8139) generated on Thu, Mar 31, 2016 08:04+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change