Clinical Document Architecture V2.0.1
2.1.0 - CI Build

Clinical Document Architecture V2.0.1, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: CDAR2.Author - JSON Profile

JSON representation of the Author logical model.

Raw json | Download


{
  "resourceType" : "StructureDefinition",
  "id" : "Author",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>Represents the humans and/or machines that authored the document.</p>\n      <p>In some cases, the role or function of the author is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is &quot;Medical Student Progress Note&quot;. The role of the author can also be recorded in the Author.functionCode or AssignedAuthor.code attribute. If either of these attributes is included, they should be equivalent to or further specialize the role inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply &quot;Physician Progress Note&quot; and the value of Author.functionCode is &quot;rounding physician&quot;), and shall not conflict with the role inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.</p>\n    </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
      "valueUri" : "urn:hl7-org:v3"
    }
  ],
  "url" : "http://hl7.org/fhir/cda/StructureDefinition/Author",
  "version" : "2.1.0",
  "name" : "CDAR2.Author",
  "title" : "Author (CDA Class)",
  "status" : "active",
  "experimental" : false,
  "date" : "2021-04-15T20:51:17+00:00",
  "publisher" : "Health Level 7",
  "description" : "Represents the humans and/or machines that authored the document. In some cases, the role or function of the author is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is \"Medical Student Progress Note\". The role of the author can also be recorded in the Author.functionCode or AssignedAuthor.code attribute. If either of these attributes is included, they should be equivalent to or further specialize the role inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply \"Physician Progress Note\" and the value of Author.functionCode is \"rounding physician\"), and shall not conflict with the role inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.",
  "fhirVersion" : "4.0.1",
  "kind" : "logical",
  "abstract" : false,
  "type" : "Author",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "Author",
        "path" : "Author",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "isModifier" : false
      },
      {
        "id" : "Author.nullFlavor",
        "path" : "Author.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" : "Author.nullFlavor",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
        }
      },
      {
        "id" : "Author.typeCode",
        "path" : "Author.typeCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Author.typeCode",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "fixedCode" : "AUT",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
        }
      },
      {
        "id" : "Author.contextControlCode",
        "path" : "Author.contextControlCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Author.contextControlCode",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "fixedCode" : "OP",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
        }
      },
      {
        "id" : "Author.realmCode",
        "path" : "Author.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" : "Author.realmCode",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
          }
        ]
      },
      {
        "id" : "Author.typeId",
        "path" : "Author.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" : "Author.typeId",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "Author.templateId",
        "path" : "Author.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" : "Author.templateId",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
          }
        ]
      },
      {
        "id" : "Author.functionCode",
        "path" : "Author.functionCode",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Author.functionCode",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
          }
        ]
      },
      {
        "id" : "Author.time",
        "path" : "Author.time",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "Author.time",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
          }
        ]
      },
      {
        "id" : "Author.assignedAuthor",
        "path" : "Author.assignedAuthor",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "Author.assignedAuthor",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "Author",
        "path" : "Author",
        "min" : 1,
        "max" : "1"
      },
      {
        "id" : "Author.nullFlavor",
        "path" : "Author.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" : "Author.typeCode",
        "path" : "Author.typeCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "code"
          }
        ],
        "fixedCode" : "AUT",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationType"
        }
      },
      {
        "id" : "Author.contextControlCode",
        "path" : "Author.contextControlCode",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "code"
          }
        ],
        "fixedCode" : "OP",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ContextControl"
        }
      },
      {
        "id" : "Author.realmCode",
        "path" : "Author.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" : "Author.typeId",
        "path" : "Author.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" : "Author.templateId",
        "path" : "Author.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" : "Author.functionCode",
        "path" : "Author.functionCode",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
          }
        ]
      },
      {
        "id" : "Author.time",
        "path" : "Author.time",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
          }
        ]
      },
      {
        "id" : "Author.assignedAuthor",
        "path" : "Author.assignedAuthor",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor"
          }
        ]
      }
    ]
  }
}