Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions

Logical Model: au-ObservationMedia - JSON Profile

Active as of 2024-11-22

JSON representation of the au-ObservationMedia logical model.

Raw json | Download

{
  "resourceType" : "StructureDefinition",
  "id" : "au-ObservationMedia",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>A derivative of the RIM Observation class that represents multimedia that is logically part of the current document. This class is only for multimedia that is logically part of the attested content of the document. Rendering a referenced ObservationMedia requires a software tool that recognizes the particular MIME media type.</p>\n      <p>An XML attribute &quot;ID&quot; of type XML ID, is added to ObservationMedia within the CDA Schema. This attribute serves as the target of a renderMultiMedia reference (see renderMultiMedia). All values of attributes of type XML ID must be unique within the document (per the W3C XML specification).</p>\n      <p>The distinction between ObservationMedia and ExternalObservation is that ObservationMedia entries are part of the attested content of the document whereas ExternalObservations are not. For instance, when a clinician draws a picture as part of a progress note, that picture is represented as a CDA ObservationMedia. If that clinician is also describing a finding seen on a chest-x-ray, the referenced chest-x-ray is represented as a CDA ExternalObservation.</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/xml-name",
      "valueString" : "observationMedia"
    },
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
      "valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    },
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
      "valueUri" : "cda"
    }
  ],
  "url" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia",
  "version" : "1.0.0",
  "name" : "au-ObservationMedia",
  "title" : "ADHA ObservationMedia (CDA Class)",
  "status" : "active",
  "experimental" : false,
  "date" : "2024-11-22T03:02:41+00:00",
  "publisher" : "Australian Digital Health Agency",
  "contact" : [
    {
      "name" : "Australian Digital Health Agency",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:help@digitalhealth.gov.au"
        }
      ]
    }
  ],
  "description" : "**Australian adaptation of the [HL7 International CDA ObservationMedia class](     https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ObservationMedia.html)**.     \n\nThis is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "AU"
        }
      ]
    }
  ],
  "copyright" : "Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/).",
  "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/ObservationMedia",
  "baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "ObservationMedia",
        "path" : "ObservationMedia",
        "short" : "Australian adaptation of the HL7 International CDA ObservationMedia class",
        "definition" : "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "isModifier" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "ObservationMedia.nullFlavor",
        "path" : "ObservationMedia.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" : "ObservationMedia.realmCode",
        "path" : "ObservationMedia.realmCode",
        "definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "InfrastructureRoot.realmCode",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
          }
        ]
      },
      {
        "id" : "ObservationMedia.typeId",
        "path" : "ObservationMedia.typeId",
        "definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "InfrastructureRoot.typeId",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "ObservationMedia.typeId.nullFlavor",
        "path" : "ObservationMedia.typeId.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" : "ObservationMedia.typeId.assigningAuthorityName",
        "path" : "ObservationMedia.typeId.assigningAuthorityName",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Assigning Authority Name",
        "definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "II.assigningAuthorityName",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id" : "ObservationMedia.typeId.displayable",
        "path" : "ObservationMedia.typeId.displayable",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Displayable",
        "definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "II.displayable",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "boolean",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
            ]
          }
        ]
      },
      {
        "id" : "ObservationMedia.typeId.root",
        "path" : "ObservationMedia.typeId.root",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Root",
        "definition" : "Identifies the type as an HL7 Registered model",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "II.root",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"🔗 ,
              "http://hl7.org/cda/stds/core/StructureDefinition/uuid"🔗 ,
              "http://hl7.org/cda/stds/core/StructureDefinition/ruid"
            ]
          }
        ],
        "fixedString" : "2.16.840.1.113883.1.3"
      },
      {
        "id" : "ObservationMedia.typeId.extension",
        "path" : "ObservationMedia.typeId.extension",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Extension",
        "definition" : "A character string as a unique identifier within the scope of the identifier root.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "II.extension",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id" : "ObservationMedia.templateId",
        "path" : "ObservationMedia.templateId",
        "definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "InfrastructureRoot.templateId",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "ObservationMedia.ID",
        "path" : "ObservationMedia.ID",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "ObservationMedia.ID",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "id",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/xs-ID"
            ]
          }
        ]
      },
      {
        "id" : "ObservationMedia.classCode",
        "path" : "ObservationMedia.classCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "ObservationMedia.classCode",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "defaultValueCode" : "OBS",
        "fixedCode" : "OBS",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation"
        }
      },
      {
        "id" : "ObservationMedia.moodCode",
        "path" : "ObservationMedia.moodCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "ObservationMedia.moodCode",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "defaultValueCode" : "EVN",
        "fixedCode" : "EVN",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
        }
      },
      {
        "id" : "ObservationMedia.id",
        "path" : "ObservationMedia.id",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "ObservationMedia.id",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "ObservationMedia.languageCode",
        "path" : "ObservationMedia.languageCode",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "ObservationMedia.languageCode",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/fhir/ValueSet/all-languages"
        }
      },
      {
        "id" : "ObservationMedia.value",
        "path" : "ObservationMedia.value",
        "representation" : [
          "typeAttr"
        ],
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "ObservationMedia.value",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
          }
        ]
      },
      {
        "id" : "ObservationMedia.subject",
        "path" : "ObservationMedia.subject",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "ObservationMedia.subject",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Subject"
          }
        ]
      },
      {
        "id" : "ObservationMedia.specimen",
        "path" : "ObservationMedia.specimen",
        "short" : "Australian-adapted Specimen class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "ObservationMedia.specimen",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Specimen"
          }
        ]
      },
      {
        "id" : "ObservationMedia.performer",
        "path" : "ObservationMedia.performer",
        "short" : "Australian-adapted Performer class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "ObservationMedia.performer",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Performer2"
          }
        ]
      },
      {
        "id" : "ObservationMedia.author",
        "path" : "ObservationMedia.author",
        "short" : "Australian-adapted Author class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "ObservationMedia.author",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Author"
          }
        ]
      },
      {
        "id" : "ObservationMedia.informant",
        "path" : "ObservationMedia.informant",
        "short" : "Australian-adapted Informant class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "ObservationMedia.informant",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Informant"
          }
        ]
      },
      {
        "id" : "ObservationMedia.participant",
        "path" : "ObservationMedia.participant",
        "short" : "Australian-adapted Participant2 class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "ObservationMedia.participant",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Participant2"
          }
        ]
      },
      {
        "id" : "ObservationMedia.entryRelationship",
        "path" : "ObservationMedia.entryRelationship",
        "short" : "Australian-adapted EntryRelationship class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "ObservationMedia.entryRelationship",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntryRelationship"
          }
        ]
      },
      {
        "id" : "ObservationMedia.reference",
        "path" : "ObservationMedia.reference",
        "short" : "Australian-adapted Reference class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "ObservationMedia.reference",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Reference"
          }
        ]
      },
      {
        "id" : "ObservationMedia.precondition",
        "path" : "ObservationMedia.precondition",
        "short" : "Australian-adapted Precondition class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "ObservationMedia.precondition",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Precondition"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "ObservationMedia",
        "path" : "ObservationMedia",
        "short" : "Australian adaptation of the HL7 International CDA ObservationMedia class",
        "min" : 1,
        "max" : "1"
      },
      {
        "id" : "ObservationMedia.ID",
        "path" : "ObservationMedia.ID",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "id",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/xs-ID"
            ]
          }
        ]
      },
      {
        "id" : "ObservationMedia.classCode",
        "path" : "ObservationMedia.classCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "code",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "defaultValueCode" : "OBS",
        "fixedCode" : "OBS",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation"
        }
      },
      {
        "id" : "ObservationMedia.moodCode",
        "path" : "ObservationMedia.moodCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "code",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "defaultValueCode" : "EVN",
        "fixedCode" : "EVN",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
        }
      },
      {
        "id" : "ObservationMedia.id",
        "path" : "ObservationMedia.id",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "ObservationMedia.languageCode",
        "path" : "ObservationMedia.languageCode",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/fhir/ValueSet/all-languages"
        }
      },
      {
        "id" : "ObservationMedia.value",
        "path" : "ObservationMedia.value",
        "representation" : [
          "typeAttr"
        ],
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
          }
        ]
      },
      {
        "id" : "ObservationMedia.subject",
        "path" : "ObservationMedia.subject",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Subject"
          }
        ]
      },
      {
        "id" : "ObservationMedia.specimen",
        "path" : "ObservationMedia.specimen",
        "short" : "Australian-adapted Specimen class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Specimen"
          }
        ]
      },
      {
        "id" : "ObservationMedia.performer",
        "path" : "ObservationMedia.performer",
        "short" : "Australian-adapted Performer class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Performer2"
          }
        ]
      },
      {
        "id" : "ObservationMedia.author",
        "path" : "ObservationMedia.author",
        "short" : "Australian-adapted Author class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Author"
          }
        ]
      },
      {
        "id" : "ObservationMedia.informant",
        "path" : "ObservationMedia.informant",
        "short" : "Australian-adapted Informant class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Informant"
          }
        ]
      },
      {
        "id" : "ObservationMedia.participant",
        "path" : "ObservationMedia.participant",
        "short" : "Australian-adapted Participant2 class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Participant2"
          }
        ]
      },
      {
        "id" : "ObservationMedia.entryRelationship",
        "path" : "ObservationMedia.entryRelationship",
        "short" : "Australian-adapted EntryRelationship class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntryRelationship"
          }
        ]
      },
      {
        "id" : "ObservationMedia.reference",
        "path" : "ObservationMedia.reference",
        "short" : "Australian-adapted Reference class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Reference"
          }
        ]
      },
      {
        "id" : "ObservationMedia.precondition",
        "path" : "ObservationMedia.precondition",
        "short" : "Australian-adapted Precondition class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Precondition"
          }
        ]
      }
    ]
  }
}