USRealmHeaderforPatientGeneratedDocument
type: StructureDefinition
node role: treeRoot
id:
  v: USRealmHeaderforPatientGeneratedDocument
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition USRealmHeaderforPatientGeneratedDocument Name Flags Card. Type Description & Constraints ClinicalDocument 1..1 USRealmHeader XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) #xD; templateId 2..* II #xD; Slices for templateId Content/Rules for all slices #xD; templateId:us-patient-gen-doc 1..1 II #xD; @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.29.1 #xD; @extension 1..1 st Required Pattern: 2024-05-01 #xD; recordTarget 1..1 RecordTarget The recordTarget records the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element. If the document receiver is interested in setting up a translator for the encounter with the patient, the receiver of the document will have to infer the need for a translator, based upon the language skills identified for the patient, the patient's language of preference and the predominant language used by the organization receiving the CDA. HL7 Vocabulary simply describes guardian as a relationship to a ward. This need not be a formal legal relationship. When a guardian relationship exists for the patient, it can be represented, regardless of who is present at the time the document is generated. This need not be a formal legal relationship. A child's parent can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "mother" for the child's mom or "father" for the child's dad. An elderly person's child can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "daughter" or "son", or if a legal relationship existed, the relationship of "legal guardian" could be encoded. #xD; patientRole 1..1 PatientRole #xD; id 1..* II #xD; patient <a style="padding-left: 3px; padding-r…
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-target
    l: logical-target
  value: Boolean
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        l: data-absent-reason
      value: Code
        v: not-applicable
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:v3
    l: v3
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: ClinicalDocument
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/type-profile-style
    l: type-profile-style
  value: Code
    v: cda
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-container
    l: logical-container
  value: Uri
    v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
    l: ClinicalDocument
url:
  v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument
  l: USRealmHeaderforPatientGeneratedDocument
identifier:
  system:
    v: urn:ietf:rfc:3986
    l: 3986
  value:
    v: urn:hl7ii:2.16.840.1.113883.10.20.29.1:2024-05-01
version:
  v: 5.0.0
name:
  v: USRealmHeaderforPatientGeneratedDocument
title:
  v: US Realm Header for Patient Generated Document
status:
  v: active
date:
  v: 2026-06-13T01:56:42+10:00
publisher:
  v: Health Level Seven
contact:
  name:
    v: HL7 International - Structured Documents
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/structure
description:
  v: This template focuses on the patient or related person in the roles of author and other participants and is designed to be used in conjunction with the US Realm Header. It includes additional conformances which further constrain the US Realm Header. The Patient Generated Document Header template is not a separate document type. The document body may contain any structured or unstructured content from C-CDA.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: US
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
  l: ClinicalDocument
base definition:
  v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
  l: USRealmHeader
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 5.0.0
  element:
    id:
      v: ClinicalDocument
    path:
      v: ClinicalDocument
    short:
      v: Base for all types and resources
    definition:
      v: 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:
      v: 1
    max:
      v: 1
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: 4537-6380
      severity:
        v: error
      human:
        v: If setId is present versionNumber **SHALL** be present (CONF:4537-6380).
      expression:
        v: setId.exists() implies versionNumber.exists()
      source:
        v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
        l: USRealmHeader
    constraint:
      key:
        v: 4537-6387
      severity:
        v: error
      human:
        v: If versionNumber is present setId **SHALL** be present (CONF:4537-6387).
      expression:
        v: versionNumber.exists() implies setId.exists()
      source:
        v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
        l: USRealmHeader
    constraint:
      key:
        v: should-legalAuthenticator
      severity:
        v: warning
      human:
        v: SHOULD contain legalAuthenticator
      expression:
        v: legalAuthenticator.exists()
      source:
        v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
        l: USRealmHeader
    constraint:
      key:
        v: should-relatedParticipant
      severity:
        v: warning
      human:
        v: Documents SHOULD contain a RelatedPerson participant
      source:
        v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
        l: USRealmHeader
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: ClinicalDocument.nullFlavor
    path:
      v: ClinicalDocument.nullFlavor
    representation:
      v: xmlAttr
    label:
      v: Exceptional Value Detail
    definition:
      v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: ANY.nullFlavor

v: 0

v: 1

code:
  v: code
  l: code
profile:
  v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
  l: cs-simple

strength:
  v: required
value set:
  v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
  l: CDANullFlavor

id:
  v: ClinicalDocument.classCode
path:
  v: ClinicalDocument.classCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ClinicalDocument.classCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: DOCCLIN
binding:
  strength:
    v: example
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDAActClass
    l: CDAActClass

id:
  v: ClinicalDocument.moodCode
path:
  v: ClinicalDocument.moodCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ClinicalDocument.moodCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: EVN
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDAActMood
    l: CDAActMood

id:
  v: ClinicalDocument.realmCode
path:
  v: ClinicalDocument.realmCode
definition:
  v: When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
comment:
  v: SHALL contain exactly one [1..1] realmCode="US" (CONF:4537-16791).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ClinicalDocument.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: ClinicalDocument.realmCode.nullFlavor
path:
  v: ClinicalDocument.realmCode.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.realmCode.code
path:
  v: ClinicalDocument.realmCode.code
representation:
  v: xmlAttr
label:
  v: Code
definition:
  v: The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: CD.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
pattern: Code
  v: US

id:
  v: ClinicalDocument.realmCode.codeSystem
path:
  v: ClinicalDocument.realmCode.codeSystem
representation:
  v: xmlAttr
label:
  v: Code System
definition:
  v: Specifies the code system that defines the code.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.codeSystem
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid

id:
  v: ClinicalDocument.realmCode.codeSystemName
path:
  v: ClinicalDocument.realmCode.codeSystemName
representation:
  v: xmlAttr
label:
  v: Code System Name
definition:
  v: The common name of the coding system.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.codeSystemName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.realmCode.codeSystemVersion
path:
  v: ClinicalDocument.realmCode.codeSystemVersion
representation:
  v: xmlAttr
label:
  v: Code System Version
definition:
  v: If applicable, a version descriptor defined specifically for the given code system.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.codeSystemVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.realmCode.displayName
path:
  v: ClinicalDocument.realmCode.displayName
representation:
  v: xmlAttr
label:
  v: Display Name
definition:
  v: A name or title for the code, under which the sending system shows the code value to its users.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.displayName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.realmCode.sdtcValueSet
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSet
path:
  v: ClinicalDocument.realmCode.sdtcValueSet
representation:
  v: xmlAttr
definition:
  v: The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.valueSet
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid

id:
  v: ClinicalDocument.realmCode.sdtcValueSetVersion
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSetVersion
path:
  v: ClinicalDocument.realmCode.sdtcValueSetVersion
representation:
  v: xmlAttr
definition:
  v: The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.sdtcValueSetVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.realmCode.originalText
path:
  v: ClinicalDocument.realmCode.originalText
label:
  v: Original Text
definition:
  v: The text or phrase used as the basis for the coding.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.originalText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ED
    l: ED

id:
  v: ClinicalDocument.realmCode.qualifier
path:
  v: ClinicalDocument.realmCode.qualifier
label:
  v: Qualifier
definition:
  v: Specifies additional codes that increase the specificity of the the primary code.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.qualifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CR
    l: CR

id:
  v: ClinicalDocument.realmCode.translation
path:
  v: ClinicalDocument.realmCode.translation
representation:
  v: typeAttr
label:
  v: Translation
definition:
  v: A set of other concept descriptors that translate this concept descriptor into other code systems.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.translation
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CD
    l: CD

id:
  v: ClinicalDocument.typeId
path:
  v: ClinicalDocument.typeId
definition:
  v: ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).
comment:
  v: SHALL contain exactly one [1..1] typeId (CONF:4537-5361).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ClinicalDocument.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
    l: ClinicalDocument

id:
  v: ClinicalDocument.typeId.nullFlavor
path:
  v: ClinicalDocument.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.typeId.assigningAuthorityName
path:
  v: ClinicalDocument.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.typeId.displayable
path:
  v: ClinicalDocument.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: ClinicalDocument.typeId.root
path:
  v: ClinicalDocument.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
comment:
  v: This typeId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.1.3" (CONF:4537-5250).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: ClinicalDocument.typeId.extension
path:
  v: ClinicalDocument.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
comment:
  v: This typeId SHALL contain exactly one [1..1] @extension="POCD_HD000040" (CONF:4537-5251).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple
fixed: String
  v: POCD_HD000040

id:
  v: ClinicalDocument.templateId
path:
  v: ClinicalDocument.templateId
slicing:
  discriminator:
    type:
      v: value
    path:
      v: root
  discriminator:
    type:
      v: value
    path:
      v: extension
  rules:
    v: open
definition:
  v: 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:
  v: 2
max:
  v: *
base:
  path:
    v: ClinicalDocument.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.templateId:us-realm
path:
  v: ClinicalDocument.templateId
slice name:
  v: us-realm
definition:
  v: 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:
  v: 1
max:
  v: 1
base:
  path:
    v: ClinicalDocument.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.templateId:us-realm.nullFlavor
path:
  v: ClinicalDocument.templateId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.templateId:us-realm.assigningAuthorityName
path:
  v: ClinicalDocument.templateId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.templateId:us-realm.displayable
path:
  v: ClinicalDocument.templateId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: ClinicalDocument.templateId:us-realm.root
path:
  v: ClinicalDocument.templateId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
pattern: String
  v: 2.16.840.1.113883.10.20.22.1.1

id:
  v: ClinicalDocument.templateId:us-realm.extension
path:
  v: ClinicalDocument.templateId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple
pattern: String
  v: 2024-05-01

id:
  v: ClinicalDocument.templateId:us-patient-gen-doc
path:
  v: ClinicalDocument.templateId
slice name:
  v: us-patient-gen-doc
definition:
  v: 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:
  v: 1
max:
  v: 1
base:
  path:
    v: ClinicalDocument.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.templateId:us-patient-gen-doc.nullFlavor
path:
  v: ClinicalDocument.templateId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.templateId:us-patient-gen-doc.assigningAuthorityName
path:
  v: ClinicalDocument.templateId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.templateId:us-patient-gen-doc.displayable
path:
  v: ClinicalDocument.templateId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: ClinicalDocument.templateId:us-patient-gen-doc.root
path:
  v: ClinicalDocument.templateId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
pattern: String
  v: 2.16.840.1.113883.10.20.29.1

id:
  v: ClinicalDocument.templateId:us-patient-gen-doc.extension
path:
  v: ClinicalDocument.templateId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple
pattern: String
  v: 2024-05-01

id:
  v: ClinicalDocument.id
path:
  v: ClinicalDocument.id
short:
  v: **SHALL** be a globally unique identifier for the document (CONF:4537-9991).
definition:
  v: Represents the unique instance identifier of a clinical document.
comment:
  v: SHALL contain exactly one [1..1] id (CONF:4537-5363).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ClinicalDocument.id
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.sdtcCategory
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: category
path:
  v: ClinicalDocument.sdtcCategory
min:
  v: 0
max:
  v: *
base:
  path:
    v: ClinicalDocument.sdtcCategory
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CD
    l: CD

id:
  v: ClinicalDocument.code
path:
  v: ClinicalDocument.code
short:
  v: **SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992).
definition:
  v: The code specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note).
comment:
  v: SHALL contain exactly one [1..1] code (CONF:4537-5253).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ClinicalDocument.code
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE
binding:
  strength:
    v: example
  value set:
    v: http://hl7.org/fhir/ValueSet/doc-typecodes
    l: doc-typecodes

id:
  v: ClinicalDocument.code.nullFlavor
path:
  v: ClinicalDocument.code.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.code.code
path:
  v: ClinicalDocument.code.code
representation:
  v: xmlAttr
label:
  v: Code
definition:
  v: The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: CD.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: ClinicalDocument.code.codeSystem
path:
  v: ClinicalDocument.code.codeSystem
representation:
  v: xmlAttr
label:
  v: Code System
definition:
  v: Specifies the code system that defines the code.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: CD.codeSystem
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
pattern: String
  v: 2.16.840.1.113883.6.1

id:
  v: ClinicalDocument.code.codeSystemName
path:
  v: ClinicalDocument.code.codeSystemName
representation:
  v: xmlAttr
label:
  v: Code System Name
definition:
  v: The common name of the coding system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystemName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.code.codeSystemVersion
path:
  v: ClinicalDocument.code.codeSystemVersion
representation:
  v: xmlAttr
label:
  v: Code System Version
definition:
  v: If applicable, a version descriptor defined specifically for the given code system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystemVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.code.displayName
path:
  v: ClinicalDocument.code.displayName
representation:
  v: xmlAttr
label:
  v: Display Name
definition:
  v: A name or title for the code, under which the sending system shows the code value to its users.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.displayName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.code.sdtcValueSet
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSet
path:
  v: ClinicalDocument.code.sdtcValueSet
representation:
  v: xmlAttr
definition:
  v: The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.valueSet
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid

id:
  v: ClinicalDocument.code.sdtcValueSetVersion
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSetVersion
path:
  v: ClinicalDocument.code.sdtcValueSetVersion
representation:
  v: xmlAttr
definition:
  v: The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.sdtcValueSetVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.code.originalText
path:
  v: ClinicalDocument.code.originalText
label:
  v: Original Text
definition:
  v: The text or phrase used as the basis for the coding.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.originalText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ED
    l: ED

id:
  v: ClinicalDocument.code.qualifier
path:
  v: ClinicalDocument.code.qualifier
label:
  v: Qualifier
definition:
  v: Specifies additional codes that increase the specificity of the the primary code.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.qualifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CR
    l: CR

id:
  v: ClinicalDocument.code.translation
path:
  v: ClinicalDocument.code.translation
representation:
  v: typeAttr
label:
  v: Translation
definition:
  v: A set of other concept descriptors that translate this concept descriptor into other code systems.
min:
  v: 0
max:
  v: *
base:
  path:
    v: CD.translation
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CD
    l: CD

id:
  v: ClinicalDocument.title
path:
  v: ClinicalDocument.title
short:
  v: The title can either be a locally defined name or the displayName corresponding to clinicalDocument/code
comment:
  v: SHALL contain exactly one [1..1] title (CONF:4537-5254).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ClinicalDocument.title
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ST
    l: ST

id:
  v: ClinicalDocument.sdtcStatusCode
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: statusCode
path:
  v: ClinicalDocument.sdtcStatusCode
definition:
  v: The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ClinicalDocument.sdtcStatusCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-ActStatus
    l: v3-ActStatus

id:
  v: ClinicalDocument.effectiveTime
path:
  v: ClinicalDocument.effectiveTime
short:
  v: Document creation time
definition:
  v: Signifies the document creation time, when the document first came into being.
comment:
  v: SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ClinicalDocument.effectiveTime
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/TS
    l: TS
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime
    l: USRealmDateTime

id:
  v: ClinicalDocument.confidentialityCode
path:
  v: ClinicalDocument.confidentialityCode
short:
  v: Controls the disclosure of information in this document
comment:
  v: Confidentiality is a required contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ClinicalDocument.confidentialityCode
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE

id:
  v: ClinicalDocument.confidentialityCode.nullFlavor
path:
  v: ClinicalDocument.confidentialityCode.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.confidentialityCode.code
path:
  v: ClinicalDocument.confidentialityCode.code
representation:
  v: xmlAttr
label:
  v: Code
definition:
  v: The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: CD.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: preferred
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.16926
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.16926

id:
  v: ClinicalDocument.confidentialityCode.codeSystem
path:
  v: ClinicalDocument.confidentialityCode.codeSystem
representation:
  v: xmlAttr
label:
  v: Code System
definition:
  v: Specifies the code system that defines the code.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystem
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid

id:
  v: ClinicalDocument.confidentialityCode.codeSystemName
path:
  v: ClinicalDocument.confidentialityCode.codeSystemName
representation:
  v: xmlAttr
label:
  v: Code System Name
definition:
  v: The common name of the coding system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystemName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.confidentialityCode.codeSystemVersion
path:
  v: ClinicalDocument.confidentialityCode.codeSystemVersion
representation:
  v: xmlAttr
label:
  v: Code System Version
definition:
  v: If applicable, a version descriptor defined specifically for the given code system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystemVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.confidentialityCode.displayName
path:
  v: ClinicalDocument.confidentialityCode.displayName
representation:
  v: xmlAttr
label:
  v: Display Name
definition:
  v: A name or title for the code, under which the sending system shows the code value to its users.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.displayName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.confidentialityCode.sdtcValueSet
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSet
path:
  v: ClinicalDocument.confidentialityCode.sdtcValueSet
representation:
  v: xmlAttr
definition:
  v: The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.valueSet
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid

id:
  v: ClinicalDocument.confidentialityCode.sdtcValueSetVersion
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSetVersion
path:
  v: ClinicalDocument.confidentialityCode.sdtcValueSetVersion
representation:
  v: xmlAttr
definition:
  v: The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.sdtcValueSetVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.confidentialityCode.originalText
path:
  v: ClinicalDocument.confidentialityCode.originalText
label:
  v: Original Text
definition:
  v: The text or phrase used as the basis for the coding.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.originalText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ED
    l: ED

id:
  v: ClinicalDocument.confidentialityCode.qualifier
path:
  v: ClinicalDocument.confidentialityCode.qualifier
label:
  v: Qualifier
definition:
  v: Specifies additional codes that increase the specificity of the the primary code.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.qualifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CR
    l: CR

id:
  v: ClinicalDocument.confidentialityCode.translation
path:
  v: ClinicalDocument.confidentialityCode.translation
representation:
  v: typeAttr
label:
  v: Translation
definition:
  v: A set of other concept descriptors that translate this concept descriptor into other code systems.
min:
  v: 0
max:
  v: *
base:
  path:
    v: CD.translation
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CD
    l: CD

id:
  v: ClinicalDocument.languageCode
path:
  v: ClinicalDocument.languageCode
short:
  v: Human language of character data
definition:
  v: Specifies the human language of character data (whether they be in contents or attribute values).
comment:
  v: SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ClinicalDocument.languageCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/fhir/ValueSet/all-languages
    l: all-languages

id:
  v: ClinicalDocument.setId
path:
  v: ClinicalDocument.setId
short:
  v: An identifier that is common across all document revisions
comment:
  v: MAY contain zero or one [0..1] setId (CONF:4537-5261).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ClinicalDocument.setId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
condition:
  v: 4537-6380
condition:
  v: 4537-6387

id:
  v: ClinicalDocument.versionNumber
path:
  v: ClinicalDocument.versionNumber
short:
  v: An integer value used to version successive replacement documents
comment:
  v: MAY contain zero or one [0..1] versionNumber (CONF:4537-5264).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ClinicalDocument.versionNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/INT
    l: INT
condition:
  v: 4537-6380
condition:
  v: 4537-6387

id:
  v: ClinicalDocument.copyTime
path:
  v: ClinicalDocument.copyTime
short:
  v: Deprecated - use is discouraged
definition:
  v: Represents the time a document is released (i.e. copied or sent to a display device) from a document management system that maintains revision control over the document. Once valued, it cannot be changed. The intent is to give the viewer of the document some notion as to how long the document has been out of the safe context of its document management system.
requirements:
  v: Included for backwards compatibility with CDA, Release One. ClinicalDocument.copyTime has been deprecated because it is not part of the document at the time it is authenticated, but instead represents metadata about the document, applied at some variable time after authentication. Further use is discouraged.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ClinicalDocument.copyTime
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/TS
    l: TS

id:
  v: ClinicalDocument.recordTarget
path:
  v: ClinicalDocument.recordTarget
short:
  v: The recordTarget records the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element. If the document receiver is interested in setting up a translator for the encounter with the patient, the receiver of the document will have to infer the need for a translator, based upon the language skills identified for the patient, the patient's language of preference and the predominant language used by the organization receiving the CDA. HL7 Vocabulary simply describes guardian as a relationship to a ward. This need not be a formal legal relationship. When a guardian relationship exists for the patient, it can be represented, regardless of who is present at the time the document is generated. This need not be a formal legal relationship. A child's parent can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "mother" for the child's mom or "father" for the child's dad. An elderly person's child can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "daughter" or "son", or if a legal relationship existed, the relationship of "legal guardian" could be encoded.
comment:
  v: SHALL contain exactly one [1..1] recordTarget (CONF:1198-28460).
requirements:
  v: The recordTarget(s) of a document are stated in the header and propagate to nested content, where they cannot be overridden.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ClinicalDocument.recordTarget
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
    l: RecordTarget

id:
  v: ClinicalDocument.recordTarget.nullFlavor
path:
  v: ClinicalDocument.recordTarget.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.realmCode
path:
  v: ClinicalDocument.recordTarget.realmCode
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: ClinicalDocument.recordTarget.typeId
path:
  v: ClinicalDocument.recordTarget.typeId
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: ClinicalDocument.recordTarget.typeId.nullFlavor
path:
  v: ClinicalDocument.recordTarget.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.typeId.assigningAuthorityName
path:
  v: ClinicalDocument.recordTarget.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.typeId.displayable
path:
  v: ClinicalDocument.recordTarget.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: ClinicalDocument.recordTarget.typeId.root
path:
  v: ClinicalDocument.recordTarget.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: ClinicalDocument.recordTarget.typeId.extension
path:
  v: ClinicalDocument.recordTarget.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.templateId
path:
  v: ClinicalDocument.recordTarget.templateId
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.recordTarget.typeCode
path:
  v: ClinicalDocument.recordTarget.typeCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RecordTarget.typeCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: RCT
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
    l: CDAParticipationType

id:
  v: ClinicalDocument.recordTarget.contextControlCode
path:
  v: ClinicalDocument.recordTarget.contextControlCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: RecordTarget.contextControlCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: OP
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
    l: CDAContextControl

id:
  v: ClinicalDocument.recordTarget.patientRole
path:
  v: ClinicalDocument.recordTarget.patientRole
comment:
  v: This recordTarget SHALL contain exactly one [1..1] patientRole (CONF:1198-28461).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: RecordTarget.patientRole
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PatientRole
    l: PatientRole

id:
  v: ClinicalDocument.recordTarget.patientRole.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.realmCode
path:
  v: ClinicalDocument.recordTarget.patientRole.realmCode
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: ClinicalDocument.recordTarget.patientRole.typeId
path:
  v: ClinicalDocument.recordTarget.patientRole.typeId
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: ClinicalDocument.recordTarget.patientRole.typeId.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.typeId.assigningAuthorityName
path:
  v: ClinicalDocument.recordTarget.patientRole.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.typeId.displayable
path:
  v: ClinicalDocument.recordTarget.patientRole.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.typeId.root
path:
  v: ClinicalDocument.recordTarget.patientRole.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: ClinicalDocument.recordTarget.patientRole.typeId.extension
path:
  v: ClinicalDocument.recordTarget.patientRole.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.templateId
path:
  v: ClinicalDocument.recordTarget.patientRole.templateId
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.recordTarget.patientRole.classCode
path:
  v: ClinicalDocument.recordTarget.patientRole.classCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PatientRole.classCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: PAT
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal
    l: v3-RoleClassRelationshipFormal

id:
  v: ClinicalDocument.recordTarget.patientRole.id
path:
  v: ClinicalDocument.recordTarget.patientRole.id
comment:
  v: This patientRole SHALL contain at least one [1..*] id (CONF:1198-28462).
min:
  v: 1
max:
  v: *
base:
  path:
    v: PatientRole.id
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: identifiedBy
path:
  v: ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy
min:
  v: 0
max:
  v: *
base:
  path:
    v: PatientRole.sdtcIdentifiedBy
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
    l: IdentifiedBy

id:
  v: ClinicalDocument.recordTarget.patientRole.addr
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: ClinicalDocument.recordTarget.patientRole.addr
short:
  v: 𝗨𝗦𝗖𝗗𝗜: Address
comment:
  v: This patientRole SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5271).
min:
  v: 1
max:
  v: *
base:
  path:
    v: PatientRole.addr
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/AD
    l: AD
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress
    l: USRealmAddress

id:
  v: ClinicalDocument.recordTarget.patientRole.telecom
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: ClinicalDocument.recordTarget.patientRole.telecom
short:
  v: 𝗨𝗦𝗖𝗗𝗜: Phone Number / Email
min:
  v: 1
max:
  v: *
base:
  path:
    v: PatientRole.telecom
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/TEL
    l: TEL
constraint:
  key:
    v: should-use
  severity:
    v: warning
  human:
    v: SHOULD contain @use
  expression:
    v: nullFlavor.exists() or use.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader

id:
  v: ClinicalDocument.recordTarget.patientRole.telecom.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.telecom.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.telecom.value
path:
  v: ClinicalDocument.recordTarget.patientRole.telecom.value
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: TEL.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: url
    l: url
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/url
    l: url

id:
  v: ClinicalDocument.recordTarget.patientRole.telecom.useablePeriod
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype
    l: elementdefinition-defaulttype
  value: Canonical
    v: http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    l: SXPR-TS
path:
  v: ClinicalDocument.recordTarget.patientRole.telecom.useablePeriod
representation:
  v: typeAttr
label:
  v: Useable Period
definition:
  v: Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
min:
  v: 0
max:
  v: *
base:
  path:
    v: TEL.useablePeriod
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
    l: IVL-TS
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS
    l: EIVL-TS
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS
    l: PIVL-TS
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    l: SXPR-TS

id:
  v: ClinicalDocument.recordTarget.patientRole.telecom.use
path:
  v: ClinicalDocument.recordTarget.patientRole.telecom.use
representation:
  v: xmlAttr
label:
  v: Use Code
definition:
  v: One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
comment:
  v: Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-5375).
min:
  v: 0
max:
  v: *
base:
  path:
    v: TEL.use
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20

id:
  v: ClinicalDocument.recordTarget.patientRole.patient
path:
  v: ClinicalDocument.recordTarget.patientRole.patient
comment:
  v: This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-28465).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: PatientRole.patient
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Patient
    l: Patient
constraint:
  key:
    v: 4537-32993
  severity:
    v: error
  human:
    v: If sdtc:deceasedInd="true", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993).
  expression:
    v: sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
constraint:
  key:
    v: 4537-21000
  severity:
    v: error
  human:
    v: If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true
  expression:
    v: sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true')
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
constraint:
  key:
    v: should-maritalStatusCode
  severity:
    v: warning
  human:
    v: SHOULD contain maritalStatusCode
  expression:
    v: maritalStatusCode.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
constraint:
  key:
    v: should-us-languageCommunication
  severity:
    v: warning
  human:
    v: SHOULD contain languageCommunication
  expression:
    v: languageCommunication.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
constraint:
  key:
    v: should-languageCommunication
  severity:
    v: warning
  human:
    v: SHOULD contain languageCommunication
  expression:
    v: languageCommunication.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument
    l: USRealmHeaderforPatientGeneratedDocument

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.realmCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.realmCode
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.typeId
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.typeId
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.typeId.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.typeId.assigningAuthorityName
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.typeId.displayable
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.typeId.root
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.typeId.extension
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.templateId
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.templateId
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.classCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.classCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.classCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: PSN
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
    l: v3-EntityClassLivingSubject

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.determinerCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.determinerCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.determinerCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: INSTANCE
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
    l: v3-EntityDeterminer

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.id
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.id
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.name
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.name
comment:
  v: This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:4537-5284).
min:
  v: 1
max:
  v: *
base:
  path:
    v: Patient.name
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PN
    l: PN
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED
    l: USRealmPatientNamePTNUSFIELDED

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: desc
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc
definition:
  v: The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.sdtcDesc
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ED
    l: ED

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.administrativeGenderCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE
binding:
  strength:
    v: example
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-AdministrativeGender
    l: v3-AdministrativeGender

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthTime
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthTime
short:
  v: 𝗨𝗦𝗖𝗗𝗜: Date of Birth - **MAY** be precise to the minute (CONF:4537-32418) (For cases where information about newborn's time of birth needs to be captured)
comment:
  v: This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Patient.birthTime
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/TS
    l: TS
constraint:
  key:
    v: ts-shall-year
  severity:
    v: error
  human:
    v: **SHALL** be precise to at least the year
  expression:
    v: nullFlavor.exists() or value.toString().length() >= 4
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
constraint:
  key:
    v: ts-should-day
  severity:
    v: warning
  human:
    v: **SHOULD** be precise to at least the day
  expression:
    v: nullFlavor.exists() or value.toString().length() >= 10
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: deceasedInd
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd
short:
  v: sdtc:deceasedInd
comment:
  v: This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.sdtcDeceasedInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/BL
    l: BL

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: deceasedTime
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime
short:
  v: 𝗨𝗦𝗖𝗗𝗜: Date of Death
comment:
  v: This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.sdtcDeceasedTime
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/TS
    l: TS
constraint:
  key:
    v: should-value-att
  severity:
    v: warning
  human:
    v: SHOULD contain @value
  expression:
    v: value.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
constraint:
  key:
    v: ts-shall-year
  severity:
    v: error
  human:
    v: **SHALL** be precise to at least the year
  expression:
    v: nullFlavor.exists() or value.toString().length() >= 4
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
constraint:
  key:
    v: ts-should-day
  severity:
    v: warning
  human:
    v: **SHOULD** be precise to at least the day
  expression:
    v: nullFlavor.exists() or value.toString().length() >= 10
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: multipleBirthInd
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.sdtcMultipleBirthInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/BL
    l: BL

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: multipleBirthOrderNumber
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.sdtcMultipleBirthOrderNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/INT-POS
    l: INT-POS

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode
short:
  v: SHOULD contain maritalStatusCode
comment:
  v: This patient SHOULD contain zero or one [0..1] maritalStatusCode, which SHALL be selected from ValueSet Marital Status urn:oid:2.16.840.1.113883.1.11.12212 DYNAMIC (CONF:4537-5303).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.maritalStatusCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE
condition:
  v: should-maritalStatusCode
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12212
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12212

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode
comment:
  v: This patient MAY contain zero or one [0..1] religiousAffiliationCode, which SHALL be selected from ValueSet Religious Affiliation urn:oid:2.16.840.1.113883.1.11.19185 DYNAMIC (CONF:4537-5317).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.religiousAffiliationCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19185
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19185

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode
short:
  v: 𝗨𝗦𝗖𝗗𝗜: Race - raceCode SHALL contain only the OMB race category; detailed race values go in translation. Additional race categories are conveyed using sdtc:raceCode, following the same pattern (OMB category in root; details in translation).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Patient.raceCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.2.575
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.2.575

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.code
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.code
representation:
  v: xmlAttr
label:
  v: Code
definition:
  v: The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.codeSystem
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.codeSystem
representation:
  v: xmlAttr
label:
  v: Code System
definition:
  v: Specifies the code system that defines the code.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystem
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.codeSystemName
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.codeSystemName
representation:
  v: xmlAttr
label:
  v: Code System Name
definition:
  v: The common name of the coding system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystemName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.codeSystemVersion
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.codeSystemVersion
representation:
  v: xmlAttr
label:
  v: Code System Version
definition:
  v: If applicable, a version descriptor defined specifically for the given code system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystemVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.displayName
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.displayName
representation:
  v: xmlAttr
label:
  v: Display Name
definition:
  v: A name or title for the code, under which the sending system shows the code value to its users.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.displayName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.sdtcValueSet
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSet
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.sdtcValueSet
representation:
  v: xmlAttr
definition:
  v: The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.valueSet
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.sdtcValueSetVersion
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSetVersion
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.sdtcValueSetVersion
representation:
  v: xmlAttr
definition:
  v: The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.sdtcValueSetVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.originalText
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.originalText
label:
  v: Original Text
definition:
  v: The text or phrase used as the basis for the coding.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.originalText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ED
    l: ED

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.qualifier
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.qualifier
label:
  v: Qualifier
definition:
  v: Specifies additional codes that increase the specificity of the the primary code.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.qualifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CR
    l: CR

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.translation
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.raceCode.translation
representation:
  v: typeAttr
label:
  v: Translation
definition:
  v: A set of other concept descriptors that translate this concept descriptor into other code systems.
min:
  v: 0
max:
  v: *
base:
  path:
    v: CD.translation
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CD
    l: CD
constraint:
  key:
    v: race-not-category
  severity:
    v: error
  human:
    v: Translation SHALL NOT be used to convey additional race categories. Multiple categories must be conveyed in multiple raceCode elements.
  expression:
    v: (code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1')).not()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
binding:
  strength:
    v: preferred
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: raceCode
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode
short:
  v: 𝗨𝗦𝗖𝗗𝗜: Race - The sdtc:raceCode is only used to record additional values when the patient has indicated multiple races or additional race detail beyond the five categories required for Meaningful Use Stage 2. The prefix sdtc: SHALL be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the additional raceCode elements.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.sdtcRaceCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE
constraint:
  key:
    v: sdtc-race-not-detail
  severity:
    v: error
  human:
    v: When using translation to convey race details, the base code SHALL be a race category.
  expression:
    v: translation.exists(codeSystem = '2.16.840.1.113883.6.238') implies (code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1'))
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.25
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.25

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.code
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.code
representation:
  v: xmlAttr
label:
  v: Code
definition:
  v: The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.codeSystem
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.codeSystem
representation:
  v: xmlAttr
label:
  v: Code System
definition:
  v: Specifies the code system that defines the code.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystem
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.codeSystemName
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.codeSystemName
representation:
  v: xmlAttr
label:
  v: Code System Name
definition:
  v: The common name of the coding system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystemName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.codeSystemVersion
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.codeSystemVersion
representation:
  v: xmlAttr
label:
  v: Code System Version
definition:
  v: If applicable, a version descriptor defined specifically for the given code system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.codeSystemVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.displayName
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.displayName
representation:
  v: xmlAttr
label:
  v: Display Name
definition:
  v: A name or title for the code, under which the sending system shows the code value to its users.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.displayName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.sdtcValueSet
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSet
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.sdtcValueSet
representation:
  v: xmlAttr
definition:
  v: The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.valueSet
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.sdtcValueSetVersion
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: valueSetVersion
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.sdtcValueSetVersion
representation:
  v: xmlAttr
definition:
  v: The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.sdtcValueSetVersion
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.originalText
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.originalText
label:
  v: Original Text
definition:
  v: The text or phrase used as the basis for the coding.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CD.originalText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ED
    l: ED

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.qualifier
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.qualifier
label:
  v: Qualifier
definition:
  v: Specifies additional codes that increase the specificity of the the primary code.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: CD.qualifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CR
    l: CR

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.translation
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode.translation
representation:
  v: typeAttr
label:
  v: Translation
definition:
  v: A set of other concept descriptors that translate this concept descriptor into other code systems.
min:
  v: 0
max:
  v: *
base:
  path:
    v: CD.translation
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CD
    l: CD
constraint:
  key:
    v: race-not-category
  severity:
    v: error
  human:
    v: Translation SHALL NOT be used to convey additional race categories. Multiple categories must be conveyed in multiple raceCode elements.
  expression:
    v: (code in ('1002-5' | '2028-9' | '2054-5' | '2076-8' | '2106-3' | '2131-1')).not()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
binding:
  strength:
    v: preferred
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode
short:
  v: 𝗨𝗦𝗖𝗗𝗜: Ethnicity
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Patient.ethnicGroupCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.3
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.3

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: ethnicGroupCode
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode
short:
  v: 𝗨𝗦𝗖𝗗𝗜: Ethnicity
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.sdtcEthnicGroupCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.1
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.4.642.40.2.48.1

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian
comment:
  v: This patient MAY contain zero or more [0..*] guardian (CONF:1198-28469).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Patient.guardian
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Guardian
    l: Guardian
constraint:
  key:
    v: should-us-code
  severity:
    v: warning
  human:
    v: SHOULD contain code
  expression:
    v: code.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
constraint:
  key:
    v: should-us-addr
  severity:
    v: warning
  human:
    v: SHOULD contain addr
  expression:
    v: addr.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
constraint:
  key:
    v: should-us-telecom
  severity:
    v: warning
  human:
    v: SHOULD contain telecom
  expression:
    v: telecom.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
constraint:
  key:
    v: should-id
  severity:
    v: warning
  human:
    v: SHOULD contain id
  expression:
    v: id.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument
    l: USRealmHeaderforPatientGeneratedDocument
constraint:
  key:
    v: should-code
  severity:
    v: warning
  human:
    v: SHOULD contain code
  expression:
    v: code.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument
    l: USRealmHeaderforPatientGeneratedDocument

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.realmCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.realmCode
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.assigningAuthorityName
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.displayable
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.root
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.extension
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.templateId
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.templateId
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Guardian.classCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: GUARD
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-RoleClassAgent
    l: v3-RoleClassAgent

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.id
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.id
comment:
  v: The guardian, if present, SHOULD contain zero or more [0..*] id (CONF:1198-28470).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Guardian.id
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: identifiedBy
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy
min:
  v: 0
max:
  v: *
base:
  path:
    v: Guardian.sdtcIdentifiedBy
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
    l: IdentifiedBy

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.code
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.code
comment:
  v: The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28473).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Guardian.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.addr
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.addr
comment:
  v: The guardian, if present, SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5359).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Guardian.addr
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/AD
    l: AD
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress
    l: USRealmAddress

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom
comment:
  v: The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Guardian.telecom
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/TEL
    l: TEL
constraint:
  key:
    v: should-use
  severity:
    v: warning
  human:
    v: SHOULD contain @use
  expression:
    v: nullFlavor.exists() or use.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: TEL.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: url
    l: url
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/url
    l: url

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.useablePeriod
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype
    l: elementdefinition-defaulttype
  value: Canonical
    v: http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    l: SXPR-TS
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.useablePeriod
representation:
  v: typeAttr
label:
  v: Useable Period
definition:
  v: Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
min:
  v: 0
max:
  v: *
base:
  path:
    v: TEL.useablePeriod
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
    l: IVL-TS
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS
    l: EIVL-TS
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS
    l: PIVL-TS
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    l: SXPR-TS

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use
representation:
  v: xmlAttr
label:
  v: Use Code
definition:
  v: One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
comment:
  v: The telecom, if present, SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7993).
min:
  v: 0
max:
  v: *
base:
  path:
    v: TEL.use
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson
comment:
  v: The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Guardian.guardianPerson
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Person
    l: Person

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.realmCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.realmCode
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.assigningAuthorityName
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.displayable
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.root
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.extension
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.templateId
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.templateId
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Person.classCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: PSN
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
    l: v3-EntityClassLivingSubject

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Person.determinerCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: INSTANCE
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
    l: v3-EntityDeterminer

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name
comment:
  v: This guardianPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5386).
min:
  v: 1
max:
  v: *
base:
  path:
    v: Person.name
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PN
    l: PN
  profile:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED
    l: USRealmPersonNamePNUSFIELDED

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcDesc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: desc
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcDesc
definition:
  v: The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Person.sdtcDesc
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ED
    l: ED

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: asPatientRelationship
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship
definition:
  v: Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Person.sdtcAsPatientRelationship
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.realmCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.realmCode
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
    l: ClinicalDocument

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.displayable
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.root
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.extension
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.templateId
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.templateId
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.classCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.classCode
representation:
  v: xmlAttr
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Person.sdtcAsPatientRelationship.classCode
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: PRS

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.determinerCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.determinerCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Person.sdtcAsPatientRelationship.determinerCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: INSTANCE

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.code
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:sdtc
    l: sdtc
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.code
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Person.sdtcAsPatientRelationship.code
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CE
    l: CE

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Guardian.guardianOrganization
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Organization
    l: Organization

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace
comment:
  v: This patient MAY contain zero or one [0..1] birthplace (CONF:4537-5395).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Patient.birthplace
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Birthplace
    l: Birthplace

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.realmCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.realmCode
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.assigningAuthorityName
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.displayable
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.root
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.extension
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.templateId
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.templateId
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Birthplace.classCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: BIRTHPL
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-RoleClassPassive
    l: v3-RoleClassPassive

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place
comment:
  v: The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:4537-5396).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Birthplace.place
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/Place
    l: Place

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.realmCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.realmCode
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.realmCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/CS
    l: CS

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: InfrastructureRoot.typeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II
constraint:
  key:
    v: II-1
  severity:
    v: error
  human:
    v: An II instance must have either a root or an nullFlavor.
  expression:
    v: root.exists() or nullFlavor.exists()
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
    l: InfrastructureRoot

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.assigningAuthorityName
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.displayable
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.root
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    l: oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    l: uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    l: ruid
fixed: String
  v: 2.16.840.1.113883.1.3

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.extension
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.templateId
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.templateId
definition:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II
    l: II

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Place.classCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: PLC
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-EntityClassPlace
    l: v3-EntityClassPlace

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Place.determinerCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: INSTANCE
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
    l: v3-EntityDeterminer

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Place.name
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/EN
    l: EN

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr
comment:
  v: This place SHALL contain exactly one [1..1] addr (CONF:4537-5397).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Place.addr
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/AD
    l: AD
constraint:
  key:
    v: 4537-5402
  severity:
    v: error
  human:
    v: If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet US Core USPS State *DYNAMIC* (CONF:4537-5402).
  expression:
    v: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://terminology.hl7.org/ValueSet/USPS-State'))
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
constraint:
  key:
    v: 4537-5403
  severity:
    v: warning
  human:
    v: If country is US, this addr **MAY** contain zero or one [0..1] postalCode, which **SHALL** be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 *DYNAMIC* (CONF:4537-5403).
  expression:
    v: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.empty() or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader
constraint:
  key:
    v: should-country
  severity:
    v: warning
  human:
    v: SHOULD contain country
  expression:
    v: nullFlavor.exists() or item.country.exists()
  source:
    v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader
    l: USRealmHeader

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.isNotOrdered
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.isNotOrdered
representation:
  v: xmlAttr
label:
  v: Is Not Ordered
definition:
  v: A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: AD.isNotOrdered
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    l: bl-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.use
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.use
representation:
  v: xmlAttr
label:
  v: Use Code
definition:
  v: A set of codes advising a system or user which address in a set of like addresses to select for a given purpose.
min:
  v: 0
max:
  v: *
base:
  path:
    v: AD.use
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse
    l: CDAPostalAddressUse

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group
    l: xml-choice-group
  value: Boolean
    v: true
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item
definition:
  v: A series of items that constitute the address.
min:
  v: 0
max:
  v: *
base:
  path:
    v: AD.item
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/fhir/StructureDefinition/Base
    l: Base
constraint:
  key:
    v: AD-1
  severity:
    v: error
  human:
    v: Can only have only one of the possible item elements in each choice
  expression:
    v: (delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
    l: ClinicalDocument

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter
definition:
  v: Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: AD.item.delimiter
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ADXP
    l: ADXP
constraint:
  key:
    v: text-null
  severity:
    v: error
  human:
    v: xmlText and nullFlavor are mutually exclusive (one must be present)
  expression:
    v: (xmlText | nullFlavor).count() = 1
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ST
    l: ST

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.representation
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.mediaType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.language
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.xmlText
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.partType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.partType
representation:
  v: xmlAttr
definition:
  v: Specifies the type of the address part
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ADXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: DEL

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country
definition:
  v: Country
min:
  v: 0
max:
  v: 1
base:
  path:
    v: AD.item.country
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ADXP
    l: ADXP
constraint:
  key:
    v: text-null
  severity:
    v: error
  human:
    v: xmlText and nullFlavor are mutually exclusive (one must be present)
  expression:
    v: (xmlText | nullFlavor).count() = 1
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ST
    l: ST
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-Country2
    l: v3-Country2

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.representation
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.mediaType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.language
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.xmlText
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.partType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.partType
representation:
  v: xmlAttr
definition:
  v: Specifies the type of the address part
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ADXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: CNT

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state
definition:
  v: A sub-unit of a country with limited sovereignty in a federally organized country.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: AD.item.state
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ADXP
    l: ADXP
constraint:
  key:
    v: text-null
  severity:
    v: error
  human:
    v: xmlText and nullFlavor are mutually exclusive (one must be present)
  expression:
    v: (xmlText | nullFlavor).count() = 1
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ST
    l: ST

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.representation
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.mediaType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.language
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.xmlText
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.partType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.partType
representation:
  v: xmlAttr
definition:
  v: Specifies the type of the address part
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ADXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: STA

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county
definition:
  v: A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: AD.item.county
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ADXP
    l: ADXP
constraint:
  key:
    v: text-null
  severity:
    v: error
  human:
    v: xmlText and nullFlavor are mutually exclusive (one must be present)
  expression:
    v: (xmlText | nullFlavor).count() = 1
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ST
    l: ST

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.representation
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.mediaType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.language
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.xmlText
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.partType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.partType
representation:
  v: xmlAttr
definition:
  v: Specifies the type of the address part
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ADXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: CPA

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city
definition:
  v: The name of the city, town, village, or other community or delivery center
min:
  v: 0
max:
  v: 1
base:
  path:
    v: AD.item.city
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ADXP
    l: ADXP
constraint:
  key:
    v: text-null
  severity:
    v: error
  human:
    v: xmlText and nullFlavor are mutually exclusive (one must be present)
  expression:
    v: (xmlText | nullFlavor).count() = 1
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ST
    l: ST

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.representation
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.mediaType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.language
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.xmlText
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.partType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.partType
representation:
  v: xmlAttr
definition:
  v: Specifies the type of the address part
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ADXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: CTY

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode
definition:
  v: A postal code designating a region defined by the postal service.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: AD.item.postalCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ADXP
    l: ADXP
constraint:
  key:
    v: text-null
  severity:
    v: error
  human:
    v: xmlText and nullFlavor are mutually exclusive (one must be present)
  expression:
    v: (xmlText | nullFlavor).count() = 1
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ST
    l: ST

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.representation
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.mediaType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.language
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.xmlText
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.partType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.partType
representation:
  v: xmlAttr
definition:
  v: Specifies the type of the address part
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ADXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: ZIP

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine
definition:
  v: Street address line
min:
  v: 0
max:
  v: 1
base:
  path:
    v: AD.item.streetAddressLine
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ADXP
    l: ADXP
constraint:
  key:
    v: text-null
  severity:
    v: error
  human:
    v: xmlText and nullFlavor are mutually exclusive (one must be present)
  expression:
    v: (xmlText | nullFlavor).count() = 1
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ST
    l: ST

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.representation
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.mediaType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.language
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.xmlText
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.partType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.partType
representation:
  v: xmlAttr
definition:
  v: Specifies the type of the address part
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ADXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: SAL

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber
definition:
  v: The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: AD.item.houseNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ADXP
    l: ADXP
constraint:
  key:
    v: text-null
  severity:
    v: error
  human:
    v: xmlText and nullFlavor are mutually exclusive (one must be present)
  expression:
    v: (xmlText | nullFlavor).count() = 1
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ST
    l: ST

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.representation
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.mediaType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.language
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.xmlText
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.partType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.partType
representation:
  v: xmlAttr
definition:
  v: Specifies the type of the address part
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ADXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: BNR

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric
definition:
  v: The numeric portion of a building number
min:
  v: 0
max:
  v: 1
base:
  path:
    v: AD.item.houseNumberNumeric
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ADXP
    l: ADXP
constraint:
  key:
    v: text-null
  severity:
    v: error
  human:
    v: xmlText and nullFlavor are mutually exclusive (one must be present)
  expression:
    v: (xmlText | nullFlavor).count() = 1
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ST
    l: ST

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.representation
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.mediaType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.language
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.xmlText
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.partType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.partType
representation:
  v: xmlAttr
definition:
  v: Specifies the type of the address part
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ADXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: BNN

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction
definition:
  v: Direction (e.g., N, S, W, E)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: AD.item.direction
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ADXP
    l: ADXP
constraint:
  key:
    v: text-null
  severity:
    v: error
  human:
    v: xmlText and nullFlavor are mutually exclusive (one must be present)
  expression:
    v: (xmlText | nullFlavor).count() = 1
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ST
    l: ST

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.representation
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.mediaType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.language
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.xmlText
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.partType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.partType
representation:
  v: xmlAttr
definition:
  v: Specifies the type of the address part
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ADXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: DIR

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName
definition:
  v: Name of a roadway or artery recognized by a municipality (including street type and direction)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: AD.item.streetName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ADXP
    l: ADXP
constraint:
  key:
    v: text-null
  severity:
    v: error
  human:
    v: xmlText and nullFlavor are mutually exclusive (one must be present)
  expression:
    v: (xmlText | nullFlavor).count() = 1
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ST
    l: ST

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.nullFlavor
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.representation
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.mediaType
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.language
path:
  v: ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.language
representation:
  v: xmlAttr