Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft

This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: CDAR2.RelatedEntity - JSON Profile

Active as of 2023-01-16

JSON representation of the RelatedEntity logical model.

Raw json | Download


{
  "resourceType" : "StructureDefinition",
  "id" : "RelatedEntity",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>The RelatedEntity role is used to represent an informant without a role.id (e.g. a parent or guy on the street).</p>\n    </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
      "valueUri" : "urn:hl7-org:v3"
    }
  ],
  "url" : "http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity",
  "version" : "2.1.0-draft1",
  "name" : "CDAR2.RelatedEntity",
  "title" : "RelatedEntity (CDA Class)",
  "status" : "active",
  "experimental" : false,
  "date" : "2023-01-16T16:39:50+11:00",
  "publisher" : "Health Level 7",
  "contact" : [
    {
      "name" : "HL7 International - Cross-Group Projects",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cgp"
        },
        {
          "system" : "email",
          "value" : "cgp@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "The RelatedEntity role is used to represent an informant without a role.id (e.g. a parent or guy on the street).",
  "fhirVersion" : "5.0.0-snapshot3",
  "mapping" : [
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    }
  ],
  "kind" : "logical",
  "abstract" : false,
  "type" : "RelatedEntity",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "RelatedEntity",
        "path" : "RelatedEntity",
        "short" : "Base for all types and resources",
        "definition" : "Base definition for all types defined in FHIR type system.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "constraint" : [
          {
            "key" : "ele-1",
            "severity" : "error",
            "human" : "All FHIR elements must have a @value or children",
            "expression" : "hasValue() or (children().count() > id.count())",
            "source" : "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "RelatedEntity.classCode",
        "path" : "RelatedEntity.classCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "RelatedEntity.classCode",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassMutualRelationship"
        }
      },
      {
        "id" : "RelatedEntity.templateId",
        "path" : "RelatedEntity.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" : "RelatedEntity.templateId",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "RelatedEntity.code",
        "path" : "RelatedEntity.code",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "RelatedEntity.code",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
          }
        ],
        "binding" : {
          "strength" : "extensible",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType"
        }
      },
      {
        "id" : "RelatedEntity.addr",
        "path" : "RelatedEntity.addr",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "RelatedEntity.addr",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/AD"
          }
        ]
      },
      {
        "id" : "RelatedEntity.telecom",
        "path" : "RelatedEntity.telecom",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "RelatedEntity.telecom",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/TEL"
          }
        ]
      },
      {
        "id" : "RelatedEntity.effectiveTime",
        "path" : "RelatedEntity.effectiveTime",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "RelatedEntity.effectiveTime",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
          }
        ]
      },
      {
        "id" : "RelatedEntity.relatedPerson",
        "path" : "RelatedEntity.relatedPerson",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "RelatedEntity.relatedPerson",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/Person"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "RelatedEntity",
        "path" : "RelatedEntity",
        "min" : 1,
        "max" : "1"
      },
      {
        "id" : "RelatedEntity.classCode",
        "path" : "RelatedEntity.classCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassMutualRelationship"
        }
      },
      {
        "id" : "RelatedEntity.templateId",
        "path" : "RelatedEntity.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" : "*",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "RelatedEntity.code",
        "path" : "RelatedEntity.code",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
          }
        ],
        "binding" : {
          "strength" : "extensible",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType"
        }
      },
      {
        "id" : "RelatedEntity.addr",
        "path" : "RelatedEntity.addr",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/AD"
          }
        ]
      },
      {
        "id" : "RelatedEntity.telecom",
        "path" : "RelatedEntity.telecom",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/TEL"
          }
        ]
      },
      {
        "id" : "RelatedEntity.effectiveTime",
        "path" : "RelatedEntity.effectiveTime",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
          }
        ]
      },
      {
        "id" : "RelatedEntity.relatedPerson",
        "path" : "RelatedEntity.relatedPerson",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/Person"
          }
        ]
      }
    ]
  }
}