XIG: StructureDefinition/AssignedEntity

FHIR IG Statistics: StructureDefinition/AssignedEntity

Package	au.digitalhealth.cda.schema
Type	StructureDefinition
Id	AssignedEntity
FHIR Version	R5
Source	http://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-AssignedEntity.html
URL	http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Version	1.0.0
Status	active
Date	2025-07-21T22:05:27+00:00
Name	AssignedEntity
Title	AssignedEntity (CDA Class)
Realm	au
Authority	national
Description	AssignedEntity (CDA Class)
Type	http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Kind	logical

Resources that use this resource

StructureDefinition
Authenticator	Authenticator (CDA Class)
DataEnterer	DataEnterer (CDA Class)
EncompassingEncounter	EncompassingEncounter (CDA Class)
EncounterParticipant	EncounterParticipant (CDA Class)
Informant	Informant (CDA Class)
LegalAuthenticator	LegalAuthenticator (CDA Class)
Performer1	Performer1 (CDA Class)
Performer2	Performer2 (CDA Class)

Resources that this resource uses

StructureDefinition
AD	AD: PostalAddress (V3 Data Type)
CE	CE: CodedWithEquivalents (V3 Data Type)
II	II: InstanceIdentifier (V3 Data Type)
IdentifiedBy	IdentifiedBy (CDA Class)
InfrastructureRoot	InfrastructureRoot (Base Type for all CDA Classes)
Organization	Organization (CDA Class)
Person	Person (CDA Class)
TEL	TEL: TelecommunicationAddress (V3 Data Type)
cs-simple	cs: Coded Simple Value

ValueSet
CDARoleCode	CDARoleCode
v3-RoleClassAssignedEntity	RoleClassAssignedEntity
v3-RoleClassAssignedEntity	RoleClassAssignedEntity

Narrative

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

Generated Narrative: StructureDefinition AssignedEntity

Name	Card.	Type	Description & Constraints
AssignedEntity	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@classCode	0..1	cs	Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED
id	1..*	II
sdtcIdentifiedBy	0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code	0..1	CE	Binding: CDARoleCode (example)
addr	0..*	AD
telecom	0..*	TEL
assignedPerson	0..1	Person
representedOrganization	0..1	Organization
sdtcPatient	0..1	Base	XML Namespace: urn:hl7-org:sdtc XML: patient (urn:hl7-org:sdtc)
id	1..1	II	XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc
Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "AssignedEntity",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "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": "assignedEntity"
    },
    {
      "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",
      "valueCode": "cda"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://ns.electronichealth.net.au/cda/ImplementationGuide/au.digitalhealth.cda.schema"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity",
  "version": "1.0.0",
  "name": "AssignedEntity",
  "title": "AssignedEntity (CDA Class)",
  "status": "active",
  "experimental": false,
  "date": "2025-07-21T22:05:27+00:00",
  "publisher": "HL7",
  "description": "AssignedEntity (CDA Class)",
  "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/AssignedEntity",
  "baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "1.0.0"
      }
    ],
    "element": [
      {
        "id": "AssignedEntity",
        "path": "AssignedEntity",
        "short": "Base for all types and resources",
        "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": "AssignedEntity.nullFlavor",
        "path": "AssignedEntity.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": "AssignedEntity.realmCode",
        "path": "AssignedEntity.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": "AssignedEntity.typeId",
        "path": "AssignedEntity.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": "AssignedEntity.typeId.nullFlavor",
        "path": "AssignedEntity.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": "AssignedEntity.typeId.assigningAuthorityName",
        "path": "AssignedEntity.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": "AssignedEntity.typeId.displayable",
        "path": "AssignedEntity.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": "AssignedEntity.typeId.root",
        "path": "AssignedEntity.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": "AssignedEntity.typeId.extension",
        "path": "AssignedEntity.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": "AssignedEntity.templateId",
        "path": "AssignedEntity.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": "AssignedEntity.classCode",
        "path": "AssignedEntity.classCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "AssignedEntity.classCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "ASSIGNED",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
        }
      },
      {
        "id": "AssignedEntity.id",
        "path": "AssignedEntity.id",
        "min": 1,
        "max": "*",
        "base": {
          "path": "AssignedEntity.id",
          "min": 1,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "AssignedEntity.sdtcIdentifiedBy",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          },
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
            "valueString": "identifiedBy"
          }
        ],
        "path": "AssignedEntity.sdtcIdentifiedBy",
        "min": 0,
        "max": "*",
        "base": {
          "path": "AssignedEntity.sdtcIdentifiedBy",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
          }
        ]
      },
      {
        "id": "AssignedEntity.code",
        "path": "AssignedEntity.code",
        "min": 0,
        "max": "1",
        "base": {
          "path": "AssignedEntity.code",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDARoleCode"
        }
      },
      {
        "id": "AssignedEntity.addr",
        "path": "AssignedEntity.addr",
        "min": 0,
        "max": "*",
        "base": {
          "path": "AssignedEntity.addr",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/AD"
          }
        ]
      },
      {
        "id": "AssignedEntity.telecom",
        "path": "AssignedEntity.telecom",
        "min": 0,
        "max": "*",
        "base": {
          "path": "AssignedEntity.telecom",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
          }
        ]
      },
      {
        "id": "AssignedEntity.assignedPerson",
        "path": "AssignedEntity.assignedPerson",
        "min": 0,
        "max": "1",
        "base": {
          "path": "AssignedEntity.assignedPerson",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/Person"
          }
        ]
      },
      {
        "id": "AssignedEntity.representedOrganization",
        "path": "AssignedEntity.representedOrganization",
        "min": 0,
        "max": "1",
        "base": {
          "path": "AssignedEntity.representedOrganization",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
          }
        ]
      },
      {
        "id": "AssignedEntity.sdtcPatient",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          },
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
            "valueString": "patient"
          }
        ],
        "path": "AssignedEntity.sdtcPatient",
        "min": 0,
        "max": "1",
        "base": {
          "path": "AssignedEntity.sdtcPatient",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/fhir/StructureDefinition/Base"
          }
        ]
      },
      {
        "id": "AssignedEntity.sdtcPatient.id",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          }
        ],
        "path": "AssignedEntity.sdtcPatient.id",
        "min": 1,
        "max": "1",
        "base": {
          "path": "AssignedEntity.sdtcPatient.id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "AssignedEntity",
        "path": "AssignedEntity",
        "min": 1,
        "max": "1"
      },
      {
        "id": "AssignedEntity.classCode",
        "path": "AssignedEntity.classCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "ASSIGNED",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
        }
      },
      {
        "id": "AssignedEntity.id",
        "path": "AssignedEntity.id",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "AssignedEntity.sdtcIdentifiedBy",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          },
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
            "valueString": "identifiedBy"
          }
        ],
        "path": "AssignedEntity.sdtcIdentifiedBy",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
          }
        ]
      },
      {
        "id": "AssignedEntity.code",
        "path": "AssignedEntity.code",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDARoleCode"
        }
      },
      {
        "id": "AssignedEntity.addr",
        "path": "AssignedEntity.addr",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/AD"
          }
        ]
      },
      {
        "id": "AssignedEntity.telecom",
        "path": "AssignedEntity.telecom",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
          }
        ]
      },
      {
        "id": "AssignedEntity.assignedPerson",
        "path": "AssignedEntity.assignedPerson",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/Person"
          }
        ]
      },
      {
        "id": "AssignedEntity.representedOrganization",
        "path": "AssignedEntity.representedOrganization",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
          }
        ]
      },
      {
        "id": "AssignedEntity.sdtcPatient",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          },
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
            "valueString": "patient"
          }
        ],
        "path": "AssignedEntity.sdtcPatient",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/fhir/StructureDefinition/Base"
          }
        ]
      },
      {
        "id": "AssignedEntity.sdtcPatient.id",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          }
        ],
        "path": "AssignedEntity.sdtcPatient.id",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      }
    ]
  }
}