description: Starting point for a specification for a composition of a FHIR Clinical Document.
package_name: hl7.fhir.uv.fhir-clinical-document
derivation: constraint
name: ClinicalDocumentComposition
type: Composition
elements:
  category:
    mustSupport: true
    index: 15
    slicing:
      rules: open
      discriminator:
      - {path: text, type: value}
      min: 1
      slices:
        clinicalnotecategory:
          match: {text: null}
          schema:
            short: Category for Clinical Note
            mustSupport: true
            pattern:
              type: CodeableConcept
              value:
                coding:
                - {code: 107903-7, system: 'http://loinc.org', display: Clinical note}
            _required: true
            type: CodeableConcept
            index: 16
          min: 1
          max: 1
  date: {mustSupport: true, index: 18}
  section:
    mustSupport: true
    index: 55
    extensions:
      change-made: {url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ChangeMade', min: 0, max: 1, type: Extension, mustSupport: true, index: 57}
    elements:
      extension:
        index: 56
        slicing:
          rules: open
          ordered: false
          discriminator:
          - {path: url, type: value}
          min: null
          slices:
            change-made:
              match: {url: null}
              schema: {type: Extension, mustSupport: true, url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ChangeMade', index: 57}
              min: 0
              max: 1
      title: {mustSupport: true, index: 58}
      code: {mustSupport: true, index: 59}
      text: {mustSupport: true, index: 60}
    required: [title]
  attester:
    mustSupport: true
    index: 21
    elements:
      mode: {mustSupport: true, index: 22}
      time: {mustSupport: true, index: 23}
      party: {mustSupport: true, index: 24}
    slicing:
      rules: open
      description: Slicing based on the resource type
      discriminator:
      - {path: mode, type: value}
      min: null
      slices:
        legal_attester:
          match: {mode: legal}
          schema:
            short: aka legal authenticator
            mustSupport: true
            index: 25
            elements:
              mode:
                pattern: {type: code, value: legal}
                type: code
                index: 26
        professional_attester:
          match: {mode: professional}
          schema:
            short: aka authenticator
            mustSupport: true
            array: true
            index: 27
            elements:
              mode:
                pattern: {type: code, value: professional}
                type: code
                index: 28
  type: {mustSupport: true, index: 14}
  title: {mustSupport: true, index: 20}
  author:
    type: Reference
    mustSupport: true
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    index: 19
  extension:
    index: 2
    slicing:
      rules: open
      ordered: false
      discriminator:
      - {path: url, type: value}
      min: null
      slices:
        R5-Composition-version:
          match: {url: null}
          schema: {type: Extension, mustSupport: true, label: clinical document version number, url: 'http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version', index: 3}
          min: 0
          max: 1
        data-enterer:
          match: {url: null}
          schema: {short: 'A Data Enterer represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content, subject to their own interpretation; a dataEnterer adds an author''s information to the electronic system.', type: Extension, mustSupport: true, label: date enterer, url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/data-enterer-extension', index: 4}
          min: 0
          max: 1
        informant:
          match: {url: null}
          schema: {short: An Informant is an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient., type: Extension, mustSupport: true, label: informant, url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/informant-extension', index: 5}
          min: 0
        information-recipient:
          match: {url: null}
          schema: {short: An Information Recipient is the intended recipient of the information at the time the document was created., type: Extension, mustSupport: true, label: 'information recipient of type primary, secondary information recipient or a generic information recipient', url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/information-recipient-extension', index: 6}
          min: 0
        participant:
          match: {url: null}
          schema: {short: 'A Participant that is not a data-enter, information-recipient nor an informant', type: Extension, mustSupport: true, label: 'A Participant that is not a data-enter, information-recipient nor an informant', url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ParticipantExtension', index: 7}
          min: 0
        consent:
          match: {url: null}
          schema: {short: consent, type: Extension, mustSupport: true, label: consent, url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/consent-extension', index: 8}
          min: 0
        basedOn:
          match: {url: null}
          schema: {short: 'The clinical action, such as a plan, proposal or order that is fulfilled by or precipitated this FHIR Clinical Document, such as a radiologists report of an x-ray.', type: Extension, mustSupport: true, label: 'basedOn, e.g. order fullfilled', url: 'http://hl7.org/fhir/StructureDefinition/event-basedOn|5.2.0', index: 9}
          min: 0
        change-made:
          match: {url: null}
          schema: {short: 'Note of changes made, calculating changes maybe required for safety as this extension may not contain all changes. Experimental, may overlap with other elements such as FHIR R6 note.', type: Extension, mustSupport: true, label: 'Note of changes made, calculating changes maybe required for safety as this extension may not contain all changes. Experimental, may overlap with other elements such as FHIR R6 note.', url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ChangeMade', index: 10}
          min: 0
          max: 1
  custodian: {mustSupport: true, index: 29}
  language: {mustSupport: true, index: 0}
  identifier: {mustSupport: true, index: 13}
  relatesTo:
    mustSupport: true
    index: 30
    elements:
      target:
        choices: []
        index: 32
        slicing:
          rules: open
          ordered: false
          discriminator:
          - {path: $this, type: type}
          min: null
          slices:
            targetIdentifier:
              match: {}
              schema:
                short: Reference to the Bundle.identifier of the FHIR Clinical Document being appended, or to some other identifier of a non FHIR document
                choices: [targetIdentifier]
                index: 34
              min: 0
              max: 1
      targetIdentifier:
        type: Identifier
        short: Reference to the Bundle.identifier of the FHIR Clinical Document being appended, or to some other identifier of a non FHIR document
        choiceOf: target
        index: 35
        slicing:
          slices:
            targetIdentifier:
              match: {}
              schema: {type: Identifier, short: 'Reference to the Bundle.identifier of the FHIR Clinical Document being appended, or to some other identifier of a non FHIR document', choiceOf: target, index: 35}
              min: 0
              max: 1
    slicing:
      rules: open
      ordered: false
      description: Slicing based on code
      discriminator:
      - {path: code, type: value}
      - {path: target, type: type}
      min: null
      slices:
        replaced_document:
          match: {code: replaces}
          schema:
            short: The document(s) being superceded
            mustSupport: true
            array: true
            index: 36
            elements:
              code:
                pattern: {type: code, value: replaces}
                type: code
                index: 37
              target:
                short: Reference to the Bundle.identifier of the FHIR Clinical Document being replaced, or to some other identifier of a non FHIR document
                choices: [targetIdentifier]
                index: 42
                slicing:
                  slices:
                    targetIdentifier:
                      match: {}
                      schema:
                        short: Reference to the Bundle.identifier of the FHIR Clinical Document being replaced, or to some other identifier of a non FHIR document
                        choices: [targetIdentifier]
                        _required: true
                        index: 42
                      min: 1
              targetIdentifier:
                type: Identifier
                short: Reference to the Bundle.identifier of the FHIR Clinical Document being replaced, or to some other identifier of a non FHIR document
                choiceOf: target
                index: 43
                slicing:
                  slices:
                    targetIdentifier:
                      match: {}
                      schema: {type: Identifier, short: 'Reference to the Bundle.identifier of the FHIR Clinical Document being replaced, or to some other identifier of a non FHIR document', choiceOf: target, _required: true, index: 43}
                      min: 1
              target[x]:
                elements:
                  system: {index: 44}
                  value: {index: 45}
                required: [system, value]
            required: [target, targetIdentifier]
        appended_document:
          match: {code: appends}
          schema:
            short: The document(s) being appended too
            mustSupport: true
            array: true
            index: 46
            elements:
              code:
                pattern: {type: code, value: appends}
                type: code
                index: 47
              target:
                choices: [targetIdentifier]
                index: 52
                slicing:
                  slices:
                    targetIdentifier:
                      match: {}
                      schema:
                        choices: [targetIdentifier]
                        _required: true
                        index: 52
                      min: 1
              targetIdentifier:
                type: Identifier
                choiceOf: target
                index: 53
                slicing:
                  slices:
                    targetIdentifier:
                      match: {}
                      schema: {type: Identifier, choiceOf: target, _required: true, index: 53}
                      min: 1
              target[x]:
                elements:
                  use: {index: 54}
                required: [use]
            required: [target, targetIdentifier]
  subject:
    type: Reference
    mustSupport: true
    refers: ['http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Patient']
    index: 17
  modifierExtension:
    index: 11
    slicing:
      rules: open
      ordered: false
      discriminator:
      - {path: url, type: value}
      min: null
      slices:
        R5-Composition-status:
          match: {url: null}
          schema: {short: 'This allows for additional status values found in R5. However, exercise caution as the R4 Composition.status is required.', type: Extension, mustSupport: true, url: 'http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.status', isModifierReason: This element is labelled as a modifier because it is a status element that contains status values such as cancelled (which means that the resource should not be treated as valid)., index: 12}
          min: 0
          max: 1
  text: {mustSupport: true, index: 1}
package_version: 1.0.0
extensions:
  R5-Composition-version: {url: 'http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version', min: 0, max: 1, type: Extension, mustSupport: true, label: clinical document version number, index: 3}
  data-enterer: {url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/data-enterer-extension', min: 0, max: 1, short: 'A Data Enterer represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content, subject to their own interpretation; a dataEnterer adds an author''s information to the electronic system.', type: Extension, mustSupport: true, label: date enterer, index: 4}
  informant: {url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/informant-extension', min: 0, short: An Informant is an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient., type: Extension, mustSupport: true, label: informant, index: 5}
  information-recipient: {url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/information-recipient-extension', min: 0, short: An Information Recipient is the intended recipient of the information at the time the document was created., type: Extension, mustSupport: true, label: 'information recipient of type primary, secondary information recipient or a generic information recipient', index: 6}
  participant: {url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ParticipantExtension', min: 0, short: 'A Participant that is not a data-enter, information-recipient nor an informant', type: Extension, mustSupport: true, label: 'A Participant that is not a data-enter, information-recipient nor an informant', index: 7}
  consent: {url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/consent-extension', min: 0, short: consent, type: Extension, mustSupport: true, label: consent, index: 8}
  basedOn: {url: 'http://hl7.org/fhir/StructureDefinition/event-basedOn|5.2.0', min: 0, short: 'The clinical action, such as a plan, proposal or order that is fulfilled by or precipitated this FHIR Clinical Document, such as a radiologists report of an x-ray.', type: Extension, mustSupport: true, label: 'basedOn, e.g. order fullfilled', index: 9}
  change-made: {url: 'http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ChangeMade', min: 0, max: 1, short: 'Note of changes made, calculating changes maybe required for safety as this extension may not contain all changes. Experimental, may overlap with other elements such as FHIR R6 note.', type: Extension, mustSupport: true, label: 'Note of changes made, calculating changes maybe required for safety as this extension may not contain all changes. Experimental, may overlap with other elements such as FHIR R6 note.', index: 10}
class: profile
kind: resource
url: http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/clinical-document-composition
base: http://hl7.org/fhir/StructureDefinition/Composition
version: 1.0.0
required: [category, section, subject]