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.RecordTarget - JSON Profile

Active as of 2023-01-16

JSON representation of the RecordTarget logical model.

Raw json | Download


{
  "resourceType" : "StructureDefinition",
  "id" : "RecordTarget",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>The recordTarget represents the medical record that this document belongs to.</p>\n      <p>A clinical document typically has exactly one recordTarget participant. In the uncommon case where a clinical document (such as a group encounter note) is placed into more than one patient chart, more than one recordTarget participants can be stated.</p>\n      <p>The recordTarget(s) of a document are stated in the header and propagate to nested content, where they cannot be overridden (see See CDA Context (§ 4.4 )).</p>\n      <p>A recordTarget is represented as a relationship between a person and an organization, where the person is in a patient role (PatientRole class). The entity playing the role is a patient (Patient class). The entity scoping the role is an organization (Organization class). A patient is uniquely identified via the PatientRole.id attribute.</p>\n      <p>CDA Release One allowed for additional person identifiers, corresponding to the Patient.id attribute in CDA Release Two. This attribute is included for backwards compatibility and has been deprecated because having two different ways to identify a patient can result in inconsistent usage. Further use of Patient.id is discouraged.</p>\n    </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
      "valueUri" : "urn:hl7-org:v3"
    }
  ],
  "url" : "http://hl7.org/fhir/cda/StructureDefinition/RecordTarget",
  "version" : "2.1.0-draft1",
  "name" : "CDAR2.RecordTarget",
  "title" : "RecordTarget (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 recordTarget represents the medical record that this document belongs to. A clinical document typically has exactly one recordTarget participant. In the uncommon case where a clinical document (such as a group encounter note) is placed into more than one patient chart, more than one recordTarget participants can be stated. The recordTarget(s) of a document are stated in the header and propagate to nested content, where they cannot be overridden (see See CDA Context (§ 4.4 )).",
  "fhirVersion" : "5.0.0-snapshot3",
  "mapping" : [
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    }
  ],
  "kind" : "logical",
  "abstract" : false,
  "type" : "RecordTarget",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "RecordTarget",
        "path" : "RecordTarget",
        "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" : "RecordTarget.nullFlavor",
        "path" : "RecordTarget.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" : "RecordTarget.nullFlavor",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
        }
      },
      {
        "id" : "RecordTarget.typeCode",
        "path" : "RecordTarget.typeCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "RecordTarget.typeCode",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "fixedCode" : "RCT",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
        }
      },
      {
        "id" : "RecordTarget.contextControlCode",
        "path" : "RecordTarget.contextControlCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "RecordTarget.contextControlCode",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "fixedCode" : "OP",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
        }
      },
      {
        "id" : "RecordTarget.realmCode",
        "path" : "RecordTarget.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" : "RecordTarget.realmCode",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
          }
        ]
      },
      {
        "id" : "RecordTarget.typeId",
        "path" : "RecordTarget.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" : "RecordTarget.typeId",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "RecordTarget.templateId",
        "path" : "RecordTarget.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" : "RecordTarget.templateId",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "RecordTarget.patientRole",
        "path" : "RecordTarget.patientRole",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "RecordTarget.patientRole",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/PatientRole"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "RecordTarget",
        "path" : "RecordTarget",
        "min" : 1,
        "max" : "1"
      },
      {
        "id" : "RecordTarget.nullFlavor",
        "path" : "RecordTarget.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",
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
        }
      },
      {
        "id" : "RecordTarget.typeCode",
        "path" : "RecordTarget.typeCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "code"
          }
        ],
        "fixedCode" : "RCT",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
        }
      },
      {
        "id" : "RecordTarget.contextControlCode",
        "path" : "RecordTarget.contextControlCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "code"
          }
        ],
        "fixedCode" : "OP",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
        }
      },
      {
        "id" : "RecordTarget.realmCode",
        "path" : "RecordTarget.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" : "*",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
          }
        ]
      },
      {
        "id" : "RecordTarget.typeId",
        "path" : "RecordTarget.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",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "RecordTarget.templateId",
        "path" : "RecordTarget.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" : "RecordTarget.patientRole",
        "path" : "RecordTarget.patientRole",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/PatientRole"
          }
        ]
      }
    ]
  }
}