FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server  |  FHIR Version n/a  User: [n/a]

Resource StructureDefinition/FHIR Server from package au.digitalhealth.cda.schema#current (31 ms)

Package au.digitalhealth.cda.schema
Type StructureDefinition
Id Id
FHIR Version R5
Source http://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-ED.html
Url http://hl7.org/cda/stds/core/StructureDefinition/ED
Version 0.1.0
Status active
Date 2024-07-08T01:49:15+00:00
Name ED
Title ED: EncapsulatedData (V3 Data Type)
Experimental False
Realm au
Authority national
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.
Type http://hl7.org/cda/stds/core/StructureDefinition/ED
Kind logical

Resources that use this resource

StructureDefinition
http://hl7.org/cda/stds/core/StructureDefinition/Act Act (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/Authenticator Authenticator (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/CD CD: ConceptDescriptor (V3 Data Type)
http://hl7.org/cda/stds/core/StructureDefinition/Criterion Criterion (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/ED ED: EncapsulatedData (V3 Data Type)
http://hl7.org/cda/stds/core/StructureDefinition/Encounter Encounter (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/Entity Entity (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/ExternalAct ExternalAct (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument ExternalDocument (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/ExternalObservation ExternalObservation (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/ExternalProcedure ExternalProcedure (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator LegalAuthenticator (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/NonXMLBody NonXMLBody (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/Observation Observation (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia ObservationMedia (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/ObservationRange ObservationRange (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/Organizer Organizer (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/ParentDocument ParentDocument (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/Patient Patient (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/Person Person (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity PlayingEntity (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/Procedure Procedure (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/SubjectPerson SubjectPerson (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration SubstanceAdministration (CDA Class)
http://hl7.org/cda/stds/core/StructureDefinition/Supply Supply (CDA Class)
asQualifications ADHA extension asEmployment
asQualifiedEntity ADHA extension asQualifiedEntity
au-Act ADHA Act (CDA Class)
au-Code ADHA CD: ConceptDescriptor (V3 Data Type)
au-Encounter ADHA Encounter (CDA Class)
au-Entity ADHA Entity (CDA Class)
au-ExternalAct ADHA ExternalAct (CDA Class)
au-ExternalDocument ADHA ExternalDocument (CDA Class)
au-Observation ADHA Observation (CDA Class)
au-ObservationMedia ADHA ObservationMedia (CDA Class)
au-ObservationRange ADHA ObservationRange (CDA Class)
au-ParentDocument ADHA ParentDocument (CDA Class)
au-PlayingEntity ADHA PlayingEntity (CDA Class)
au-Procedure ADHA Procedure (CDA Class)
au-SubstanceAdministration ADHA SubstanceAdministration (CDA Class)
au-Supply ADHA Supply (CDA Class)
controlAct ADHA extension controlAct
http://hl7.org/cda/us/ccda/StructureDefinition/BrandNameObservation Brand Name Observation
http://hl7.org/cda/us/ccda/StructureDefinition/CareExperiencePreference Care Experience Preference
http://hl7.org/cda/us/ccda/StructureDefinition/CatalogNumberObservation Catalog Number Observation
http://hl7.org/cda/us/ccda/StructureDefinition/CompanyNameObservation Company Name Observation
http://hl7.org/cda/us/ccda/StructureDefinition/DistinctIdentificationCodeObservation Distinct Identification Code Observation
http://hl7.org/cda/us/ccda/StructureDefinition/LotOrBatchNumberObservation Lot or Batch Number Observation
http://hl7.org/cda/us/ccda/StructureDefinition/ModelNumberObservation Model Number Observation
http://hl7.org/cda/us/ccda/StructureDefinition/SerialNumberObservation Serial Number Observation
http://hl7.org/cda/us/ccda/StructureDefinition/TreatmentInterventionPreference Treatment Intervention Preference

Resources that this resource uses

StructureDefinition
http://hl7.org/cda/stds/core/StructureDefinition/ANY ANY: DataValue (V3 Data Type)
http://hl7.org/cda/stds/core/StructureDefinition/ED ED: EncapsulatedData (V3 Data Type)
http://hl7.org/cda/stds/core/StructureDefinition/TEL TEL: TelecommunicationAddress (V3 Data Type)
http://hl7.org/cda/stds/core/StructureDefinition/bin bin: Binary Data
http://hl7.org/cda/stds/core/StructureDefinition/cs-simple cs: Coded Simple Value
http://hl7.org/cda/stds/core/StructureDefinition/st-simple st: Character String
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding Binary Data Encoding Value Set
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm CompressionAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm IntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-MediaType MediaType


Narrative

Note: links and images are rebased to the (stated) source

Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.) Instead of the data itself, an ED may contain only a reference (see TEL.) Note that the ST data type is a specialization of the ED data type when the ED media type is text/plain.


Source

{
  "resourceType" : "StructureDefinition",
  "id" : "ED",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.) Instead of the data itself, an ED may contain only a reference (see TEL.) Note that the ST data type is a specialization of the ED data type when the ED media type is text/plain.</p>\n </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
      "_valueBoolean" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
            "valueCode" : "not-applicable"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
      "valueUri" : "urn:hl7-org:v3"
    },
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
      "valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    }
  ],
  "url" : "http://hl7.org/cda/stds/core/StructureDefinition/ED",
  "version" : "0.1.0",
  "name" : "ED",
  "title" : "ED: EncapsulatedData (V3 Data Type)",
  "status" : "active",
  "experimental" : false,
  "date" : "2024-07-08T01:49:15+00:00",
  "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.",
  "fhirVersion" : "5.0.0",
  "mapping" : [
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    }
  ],
  "kind" : "logical",
  "abstract" : false,
  "type" : "http://hl7.org/cda/stds/core/StructureDefinition/ED",
  "baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/ANY",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "ED",
        "path" : "ED",
        "short" : "Base for all types and resources",
        "definition" : "Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.) Instead of the data itself, an ED may contain only a reference (see TEL.) Note that the ST data type is a specialization of when the is text/plain.",
        "min" : 1,
        "max" : "*",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "constraint" : [
          {
            "key" : "ed-base64",
            "severity" : "error",
            "human" : "If @representation='B64', then xmlText SHALL be a base64binary string.",
            "expression" : "(representation.empty() or representation != 'B64') or xmlText.empty() or xmlText.matches('^(?:[A-Za-z0-9+//]{4})*(?:[A-Za-z0-9+//]{2}==|[A-Za-z0-9+//]{3}=)?$')"
          }
        ],
        "isModifier" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "ED.nullFlavor",
        "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",
        "base" : {
          "path" : "ANY.nullFlavor",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
        }
      },
      {
        "id" : "ED.compression",
        "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",
        "base" : {
          "path" : "ED.compression",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm"
        }
      },
      {
        "id" : "ED.integrityCheck",
        "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",
        "base" : {
          "path" : "ED.integrityCheck",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "base64Binary",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/bin"
            ]
          }
        ]
      },
      {
        "id" : "ED.integrityCheckAlgorithm",
        "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",
        "base" : {
          "path" : "ED.integrityCheckAlgorithm",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0"
        }
      },
      {
        "id" : "ED.language",
        "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",
        "base" : {
          "path" : "ED.language",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ]
      },
      {
        "id" : "ED.mediaType",
        "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",
        "base" : {
          "path" : "ED.mediaType",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "example",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-MediaType"
        }
      },
      {
        "id" : "ED.representation",
        "path" : "ED.representation",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "ED.representation",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding"
        }
      },
      {
        "id" : "ED.xmlText",
        "path" : "ED.xmlText",
        "representation" : [
          "xmlText"
        ],
        "short" : "Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.",
        "definition" : "Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)",
        "comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "ED.xmlText",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id" : "ED.reference",
        "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",
        "base" : {
          "path" : "ED.reference",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
          }
        ]
      },
      {
        "id" : "ED.thumbnail",
        "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",
        "base" : {
          "path" : "ED.thumbnail",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "ED",
        "path" : "ED",
        "definition" : "Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.) Instead of the data itself, an ED may contain only a reference (see TEL.) Note that the ST data type is a specialization of when the is text/plain.",
        "min" : 1,
        "max" : "*",
        "constraint" : [
          {
            "key" : "ed-base64",
            "severity" : "error",
            "human" : "If @representation='B64', then xmlText SHALL be a base64binary string.",
            "expression" : "(representation.empty() or representation != 'B64') or xmlText.empty() or xmlText.matches('^(?:[A-Za-z0-9+//]{4})*(?:[A-Za-z0-9+//]{2}==|[A-Za-z0-9+//]{3}=)?$')"
          }
        ]
      },
      {
        "id" : "ED.compression",
        "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",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm"
        }
      },
      {
        "id" : "ED.integrityCheck",
        "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",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/bin"
            ]
          }
        ]
      },
      {
        "id" : "ED.integrityCheckAlgorithm",
        "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",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0"
        }
      },
      {
        "id" : "ED.language",
        "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",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ]
      },
      {
        "id" : "ED.mediaType",
        "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",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "example",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-MediaType"
        }
      },
      {
        "id" : "ED.representation",
        "path" : "ED.representation",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "code",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding"
        }
      },
      {
        "id" : "ED.xmlText",
        "path" : "ED.xmlText",
        "representation" : [
          "xmlText"
        ],
        "short" : "Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.",
        "definition" : "Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)",
        "comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string",
            "profile" : [
              "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id" : "ED.reference",
        "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" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
          }
        ]
      },
      {
        "id" : "ED.thumbnail",
        "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" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
          }
        ]
      }
    ]
  }
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.