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-Organizer - JSON Profile

Active as of 2024-12-18

JSON representation of the au-Organizer logical model.

Raw json | Download

{
  "resourceType" : "StructureDefinition",
  "id" : "au-Organizer",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>A derivative of the RIM Act class, which can be used to create arbitrary groupings of other CDA entries that share a common context. An Organizer can contain other Organizers and/or other CDA entries, by traversing the component relationship. An Organizer can refer to external acts by traversing the reference relationship. An Organizer cannot be the source of an entryRelationship relationship.</p>\n      <p>NOTE: CDA entries such as Observation can also contain other CDA entries by traversing the entryRelationship class. There is no requirement that the Organizer entry be used in order to group CDA entries.</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" : "organizer"
    },
    {
      "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-Organizer",
  "version" : "1.0.0",
  "name" : "au-Organizer",
  "title" : "ADHA Organizer (CDA Class)",
  "status" : "active",
  "experimental" : false,
  "date" : "2024-12-18T05:40:48+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 Organizer class](     https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Organizer.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/Organizer",
  "baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "Organizer",
        "path" : "Organizer",
        "short" : "Australian adaptation of the HL7 International CDA Organizer 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" : "Organizer.nullFlavor",
        "path" : "Organizer.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" : "Organizer.realmCode",
        "path" : "Organizer.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" : "Organizer.typeId",
        "path" : "Organizer.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"
          }
        ],
        "constraint" : [
          {
            "key" : "II-1",
            "severity" : "error",
            "human" : "An II instance must have either a root or an nullFlavor.",
            "expression" : "root.exists() or nullFlavor.exists()",
            "source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
          }
        ]
      },
      {
        "id" : "Organizer.typeId.nullFlavor",
        "path" : "Organizer.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" : "Organizer.typeId.assigningAuthorityName",
        "path" : "Organizer.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" : "Organizer.typeId.displayable",
        "path" : "Organizer.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" : "Organizer.typeId.root",
        "path" : "Organizer.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" : "Organizer.typeId.extension",
        "path" : "Organizer.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" : "Organizer.templateId",
        "path" : "Organizer.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" : "Organizer.classCode",
        "path" : "Organizer.classCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "Organizer.classCode",
          "min" : 1,
          "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-xActClassDocumentEntryOrganizer|2.0.0"
        }
      },
      {
        "id" : "Organizer.moodCode",
        "path" : "Organizer.moodCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "Organizer.moodCode",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode" : "EVN",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
        }
      },
      {
        "id" : "Organizer.id",
        "path" : "Organizer.id",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Organizer.id",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "Organizer.code",
        "path" : "Organizer.code",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Organizer.code",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
          }
        ],
        "binding" : {
          "strength" : "example",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActCode"
        }
      },
      {
        "id" : "Organizer.statusCode",
        "path" : "Organizer.statusCode",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "Organizer.statusCode",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActStatus"
        }
      },
      {
        "id" : "Organizer.effectiveTime",
        "path" : "Organizer.effectiveTime",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Organizer.effectiveTime",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          }
        ]
      },
      {
        "id" : "Organizer.subject",
        "path" : "Organizer.subject",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Organizer.subject",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Subject"
          }
        ]
      },
      {
        "id" : "Organizer.specimen",
        "path" : "Organizer.specimen",
        "short" : "Australian-adapted Specimen class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Organizer.specimen",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Specimen"
          }
        ]
      },
      {
        "id" : "Organizer.performer",
        "path" : "Organizer.performer",
        "short" : "Australian-adapted Performer class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Organizer.performer",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Performer2"
          }
        ]
      },
      {
        "id" : "Organizer.author",
        "path" : "Organizer.author",
        "short" : "Australian-adapted Author class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Organizer.author",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Author"
          }
        ]
      },
      {
        "id" : "Organizer.informant",
        "path" : "Organizer.informant",
        "short" : "Australian-adapted Informant class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Organizer.informant",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Informant"
          }
        ]
      },
      {
        "id" : "Organizer.participant",
        "path" : "Organizer.participant",
        "short" : "Australian-adapted Participant2 class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Organizer.participant",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Participant2"
          }
        ]
      },
      {
        "id" : "Organizer.reference",
        "path" : "Organizer.reference",
        "short" : "Australian-adapted Reference class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Organizer.reference",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Reference"
          }
        ]
      },
      {
        "id" : "Organizer.precondition",
        "path" : "Organizer.precondition",
        "short" : "Australian-adapted Precondition class",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Organizer.precondition",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Precondition"
          }
        ]
      },
      {
        "id" : "Organizer.component",
        "path" : "Organizer.component",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Organizer.component",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/OrganizerComponent"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "Organizer",
        "path" : "Organizer",
        "short" : "Australian adaptation of the HL7 International CDA Organizer class",
        "min" : 1,
        "max" : "1"
      },
      {
        "id" : "Organizer.classCode",
        "path" : "Organizer.classCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "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-xActClassDocumentEntryOrganizer|2.0.0"
        }
      },
      {
        "id" : "Organizer.moodCode",
        "path" : "Organizer.moodCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "code",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode" : "EVN",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
        }
      },
      {
        "id" : "Organizer.id",
        "path" : "Organizer.id",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "Organizer.code",
        "path" : "Organizer.code",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
          }
        ],
        "binding" : {
          "strength" : "example",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActCode"
        }
      },
      {
        "id" : "Organizer.statusCode",
        "path" : "Organizer.statusCode",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActStatus"
        }
      },
      {
        "id" : "Organizer.effectiveTime",
        "path" : "Organizer.effectiveTime",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          }
        ]
      },
      {
        "id" : "Organizer.subject",
        "path" : "Organizer.subject",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Subject"
          }
        ]
      },
      {
        "id" : "Organizer.specimen",
        "path" : "Organizer.specimen",
        "short" : "Australian-adapted Specimen class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Specimen"
          }
        ]
      },
      {
        "id" : "Organizer.performer",
        "path" : "Organizer.performer",
        "short" : "Australian-adapted Performer class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Performer2"
          }
        ]
      },
      {
        "id" : "Organizer.author",
        "path" : "Organizer.author",
        "short" : "Australian-adapted Author class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Author"
          }
        ]
      },
      {
        "id" : "Organizer.informant",
        "path" : "Organizer.informant",
        "short" : "Australian-adapted Informant class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Informant"
          }
        ]
      },
      {
        "id" : "Organizer.participant",
        "path" : "Organizer.participant",
        "short" : "Australian-adapted Participant2 class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Participant2"
          }
        ]
      },
      {
        "id" : "Organizer.reference",
        "path" : "Organizer.reference",
        "short" : "Australian-adapted Reference class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Reference"
          }
        ]
      },
      {
        "id" : "Organizer.precondition",
        "path" : "Organizer.precondition",
        "short" : "Australian-adapted Precondition class",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Precondition"
          }
        ]
      },
      {
        "id" : "Organizer.component",
        "path" : "Organizer.component",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/OrganizerComponent"
          }
        ]
      }
    ]
  }
}