PACIO Advance Directive Interoperability Implementation Guide
0.1.0 - STU 1 Ballot

PACIO Advance Directive Interoperability Implementation Guide, published by HL7 Patient Empowerment Working Group. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/fhir-pacio-adi/ and changes regularly. See the Directory of published versions

Resource Profile: PACIO ADI Header

Defining URL:http://hl7.org/fhir/us/pacio-adi/StructureDefinition/PADI-Header
Version:0.1.0
Name:PADIHeader
Title:PACIO ADI Header
Status:Active as of 12/3/21, 11:52 PM
Definition:

This abstract profile defines constraints that represent common administrative and demographic concepts for advance directives information used in US Realm clinical documents.

Publisher:HL7 Patient Empowerment Working Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/pacio-adi/StructureDefinition/PADI-Header

This profile, largely based on the CCDA on FHIR US Realm Header profile, defines requirements that address specific exchange requirements for a composition containing a person’s advance care plan (PACP) information.

In the cases where the patient is not able to “write” the PACP contents due to literacy constraints or physical disability, e.g. hemiplegia, the patient/subject is still considered author of the content, and a data enterer will fill the role of physically creating the document by entering the author’s requested information into the system used to create the document.

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Clinical Document

Summary

Mandatory: 5 elements (5 nested mandatory elements)
Must-Support: 29 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Composition.attester is sliced based on the value of value:mode

This structure is derived from Clinical Document

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*Clinical DocumentThis is an abstract profile
A set of resources composed into a single coherent clinical statement with clinical attestation
... language S1..1codeLanguage of the resource content
... padi-versionNumber-extension S0..1integerVersion Number
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-versionNumber-extension
... padi-effective-date-extension S0..1PeriodEffective Date
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-effective-date-extension
... padi-dataEnterer-extension S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)Data Enterer
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-dataEnterer-extension
... padi-informant-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)Informant
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-informant-extension
... padi-informationRecipient-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson | US Core Organization Profile)Information Recipient
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-informationRecipient-extension
... padi-participant-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | RelatedPerson)Participant
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-participant-extension
... padi-performer-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)Performer
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-performer-extension
... padi-authorization-extension S0..*Reference(Consent)Authorization
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-authorization-extension
... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
... identifier S1..1IdentifierVersion-independent identifier for the Composition
... type S1..1CodeableConceptKind of composition (LOINC if possible)
Binding: Advance Directive Categories (extensible)
... category S1..1CodeableConceptCategorization of Composition
... subject S1..1Reference(US Core Patient Profile)Who and/or what the composition is about
... encounter S0..1Reference(US Core Encounter Profile)Context of the Composition
... date S1..1dateTimeComposition editing time
... author S1..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson)Who and/or what authored the composition
... title S1..1stringHuman Readable name/title
... confidentiality 0..0
... Slices for attester 0..*BackboneElementAttests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:All Slices Content/Rules for all slices
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... padi-attestationInformation-extension 1..1(Complex)Attestation Information
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-attestationInformation-extension
.... attester:legal_attester S0..1BackboneElementAttests to accuracy of composition
..... mode S1..1codepersonal | professional | legal | official
Required Pattern: legal
..... party S1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | RelatedPerson | US Core Organization Profile)Who attested the composition
.... attester:notary_attester S0..*BackboneElementAttests to accuracy of composition
..... mode S1..1codepersonal | professional | legal | official
Required Pattern: professional
..... party S1..1Reference(RelatedPerson)Who attested the composition
.... attester:witness_attester S0..*BackboneElementAttests to accuracy of composition
..... mode S1..1codepersonal | professional | legal | official
Required Pattern: personal
..... party S1..1Reference(US Core Patient Profile | RelatedPerson)Who attested the composition
... custodian S1..1Reference(US Core Organization Profile)Organization which maintains the composition
... section
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*Clinical DocumentThis is an abstract profile
A set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language S1..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... composition-clinicaldocument-versionNumber 0..*stringVersion-specific identifier for composition
URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber
... padi-versionNumber-extension S0..1integerVersion Number
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-versionNumber-extension
... padi-effective-date-extension S0..1PeriodEffective Date
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-effective-date-extension
... padi-jurisdiction-extension 0..*CodeableConceptJurisdiction
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-jurisdiction-extension
Binding: Jurisdiction ValueSet (extensible)
... padi-dataEnterer-extension S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)Data Enterer
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-dataEnterer-extension
... padi-informant-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)Informant
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-informant-extension
... padi-informationRecipient-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson | US Core Organization Profile)Information Recipient
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-informationRecipient-extension
... padi-participant-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | RelatedPerson)Participant
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-participant-extension
... padi-performer-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)Performer
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-performer-extension
... padi-authorization-extension S0..*Reference(Consent)Authorization
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-authorization-extension
... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1IdentifierVersion-independent identifier for the Composition
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type SΣ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: Advance Directive Categories (extensible)
... category SΣ1..1CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject SΣ1..1Reference(US Core Patient Profile)Who and/or what the composition is about
... encounter SΣ0..1Reference(US Core Encounter Profile)Context of the Composition
... date SΣ1..1dateTimeComposition editing time
... author SΣ1..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson)Who and/or what authored the composition
... title SΣ1..1stringHuman Readable name/title
... Slices for attester 0..*BackboneElementAttests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... padi-attestationInformation-extension I1..1(Complex)Attestation Information
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-attestationInformation-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.

..... time 0..1dateTimeWhen the composition was attested
..... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the composition
.... attester:legal_attester S0..1BackboneElementAttests to accuracy of composition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode S1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.


Required Pattern: legal
..... time 0..1dateTimeWhen the composition was attested
..... party S1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | RelatedPerson | US Core Organization Profile)Who attested the composition
.... attester:notary_attester S0..*BackboneElementAttests to accuracy of composition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode S1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.


Required Pattern: professional
..... time 0..1dateTimeWhen the composition was attested
..... party S1..1Reference(RelatedPerson)Who attested the composition
.... attester:witness_attester S0..*BackboneElementAttests to accuracy of composition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode S1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.


Required Pattern: personal
..... time 0..1dateTimeWhen the composition was attested
..... party S1..1Reference(US Core Patient Profile | RelatedPerson)Who attested the composition
... custodian SΣ1..1Reference(US Core Organization Profile)Organization which maintains the composition
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... event Σ0..*BackboneElementThe clinical service(s) being documented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... section I0..*BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
.... text I0..1NarrativeText summary of the section, for human interpretation
.... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

.... entry I0..*Reference(Resource)A reference to data that supports this section
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section I0..*See section (Composition)Nested Section

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*Clinical DocumentThis is an abstract profile
A set of resources composed into a single coherent clinical statement with clinical attestation
... language 1..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... padi-versionNumber-extension 0..1integerVersion Number
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-versionNumber-extension
... padi-effective-date-extension 0..1PeriodEffective Date
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-effective-date-extension
... padi-informant-extension 0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)Informant
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-informant-extension
... padi-informationRecipient-extension 0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson | US Core Organization Profile)Information Recipient
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-informationRecipient-extension
... padi-participant-extension 0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | RelatedPerson)Participant
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-participant-extension
... padi-performer-extension 0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)Performer
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-performer-extension
... padi-authorization-extension 0..*Reference(Consent)Authorization
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-authorization-extension
... padi-clause-extension 0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
... identifier Σ1..1IdentifierVersion-independent identifier for the Composition
... type Σ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: Advance Directive Categories (extensible)
... category Σ1..1CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject Σ1..1Reference(US Core Patient Profile)Who and/or what the composition is about
... encounter Σ0..1Reference(US Core Encounter Profile)Context of the Composition
... date Σ1..1dateTimeComposition editing time
... author Σ1..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson)Who and/or what authored the composition
... title Σ1..1stringHuman Readable name/title
... attester:legal_attester 0..1BackboneElementAttests to accuracy of composition
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.


Required Pattern: legal
.... party 1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | RelatedPerson | US Core Organization Profile)Who attested the composition
... attester:notary_attester 0..*BackboneElementAttests to accuracy of composition
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.


Required Pattern: professional
.... party 1..1Reference(RelatedPerson)Who attested the composition
... attester:witness_attester 0..*BackboneElementAttests to accuracy of composition
.... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.


Required Pattern: personal
.... party 1..1Reference(US Core Patient Profile | RelatedPerson)Who attested the composition
... custodian Σ1..1Reference(US Core Organization Profile)Organization which maintains the composition
... section I0..*BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... padi-clause-extension 0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension

doco Documentation for this format

This structure is derived from Clinical Document

Summary

Mandatory: 5 elements (5 nested mandatory elements)
Must-Support: 29 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Composition.attester is sliced based on the value of value:mode

Differential View

This structure is derived from Clinical Document

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*Clinical DocumentThis is an abstract profile
A set of resources composed into a single coherent clinical statement with clinical attestation
... language S1..1codeLanguage of the resource content
... padi-versionNumber-extension S0..1integerVersion Number
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-versionNumber-extension
... padi-effective-date-extension S0..1PeriodEffective Date
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-effective-date-extension
... padi-dataEnterer-extension S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)Data Enterer
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-dataEnterer-extension
... padi-informant-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)Informant
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-informant-extension
... padi-informationRecipient-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson | US Core Organization Profile)Information Recipient
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-informationRecipient-extension
... padi-participant-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | RelatedPerson)Participant
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-participant-extension
... padi-performer-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)Performer
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-performer-extension
... padi-authorization-extension S0..*Reference(Consent)Authorization
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-authorization-extension
... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
... identifier S1..1IdentifierVersion-independent identifier for the Composition
... type S1..1CodeableConceptKind of composition (LOINC if possible)
Binding: Advance Directive Categories (extensible)
... category S1..1CodeableConceptCategorization of Composition
... subject S1..1Reference(US Core Patient Profile)Who and/or what the composition is about
... encounter S0..1Reference(US Core Encounter Profile)Context of the Composition
... date S1..1dateTimeComposition editing time
... author S1..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson)Who and/or what authored the composition
... title S1..1stringHuman Readable name/title
... confidentiality 0..0
... Slices for attester 0..*BackboneElementAttests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:All Slices Content/Rules for all slices
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... padi-attestationInformation-extension 1..1(Complex)Attestation Information
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-attestationInformation-extension
.... attester:legal_attester S0..1BackboneElementAttests to accuracy of composition
..... mode S1..1codepersonal | professional | legal | official
Required Pattern: legal
..... party S1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | RelatedPerson | US Core Organization Profile)Who attested the composition
.... attester:notary_attester S0..*BackboneElementAttests to accuracy of composition
..... mode S1..1codepersonal | professional | legal | official
Required Pattern: professional
..... party S1..1Reference(RelatedPerson)Who attested the composition
.... attester:witness_attester S0..*BackboneElementAttests to accuracy of composition
..... mode S1..1codepersonal | professional | legal | official
Required Pattern: personal
..... party S1..1Reference(US Core Patient Profile | RelatedPerson)Who attested the composition
... custodian S1..1Reference(US Core Organization Profile)Organization which maintains the composition
... section
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..*Clinical DocumentThis is an abstract profile
A set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language S1..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... composition-clinicaldocument-versionNumber 0..*stringVersion-specific identifier for composition
URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber
... padi-versionNumber-extension S0..1integerVersion Number
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-versionNumber-extension
... padi-effective-date-extension S0..1PeriodEffective Date
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-effective-date-extension
... padi-jurisdiction-extension 0..*CodeableConceptJurisdiction
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-jurisdiction-extension
Binding: Jurisdiction ValueSet (extensible)
... padi-dataEnterer-extension S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)Data Enterer
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-dataEnterer-extension
... padi-informant-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson)Informant
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-informant-extension
... padi-informationRecipient-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Patient Profile | RelatedPerson | US Core Organization Profile)Information Recipient
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-informationRecipient-extension
... padi-participant-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | RelatedPerson)Participant
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-participant-extension
... padi-performer-extension S0..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile)Performer
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-performer-extension
... padi-authorization-extension S0..*Reference(Consent)Authorization
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-authorization-extension
... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1IdentifierVersion-independent identifier for the Composition
... status ?!Σ1..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.

... type SΣ1..1CodeableConceptKind of composition (LOINC if possible)
Binding: Advance Directive Categories (extensible)
... category SΣ1..1CodeableConceptCategorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject SΣ1..1Reference(US Core Patient Profile)Who and/or what the composition is about
... encounter SΣ0..1Reference(US Core Encounter Profile)Context of the Composition
... date SΣ1..1dateTimeComposition editing time
... author SΣ1..*Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | PractitionerRole | US Core Patient Profile | Device | RelatedPerson)Who and/or what authored the composition
... title SΣ1..1stringHuman Readable name/title
... Slices for attester 0..*BackboneElementAttests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... padi-attestationInformation-extension I1..1(Complex)Attestation Information
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-attestationInformation-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode 1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.

..... time 0..1dateTimeWhen the composition was attested
..... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the composition
.... attester:legal_attester S0..1BackboneElementAttests to accuracy of composition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode S1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.


Required Pattern: legal
..... time 0..1dateTimeWhen the composition was attested
..... party S1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | RelatedPerson | US Core Organization Profile)Who attested the composition
.... attester:notary_attester S0..*BackboneElementAttests to accuracy of composition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode S1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.


Required Pattern: professional
..... time 0..1dateTimeWhen the composition was attested
..... party S1..1Reference(RelatedPerson)Who attested the composition
.... attester:witness_attester S0..*BackboneElementAttests to accuracy of composition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode S1..1codepersonal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.


Required Pattern: personal
..... time 0..1dateTimeWhen the composition was attested
..... party S1..1Reference(US Core Patient Profile | RelatedPerson)Who attested the composition
... custodian SΣ1..1Reference(US Core Organization Profile)Organization which maintains the composition
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(Composition)
... event Σ0..*BackboneElementThe clinical service(s) being documented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..*CodeableConceptCode(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ0..1PeriodThe period covered by the documentation
.... detail Σ0..*Reference(Resource)The event(s) being documented
... section I0..*BackboneElementComposition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... padi-clause-extension S0..*(Complex)Clause
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/padi-clause-extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... title 0..1stringLabel for section (e.g. for ToC)
.... code 0..1CodeableConceptClassification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.

.... author 0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)Who and/or what authored the section
.... focus 0..1Reference(Resource)Who/what the section is about, when it is not about the subject of composition
.... text I0..1NarrativeText summary of the section, for human interpretation
.... mode 0..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.

.... orderedBy 0..1CodeableConceptOrder of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

.... entry I0..*Reference(Resource)A reference to data that supports this section
.... emptyReason I0..1CodeableConceptWhy the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.

.... section I0..*See section (Composition)Nested Section

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Composition.languagepreferredCommonLanguages
Max Binding: AllLanguages
Composition.statusrequiredCompositionStatus
Composition.typeextensiblePADIAdvanceDirectiveCategoriesVS
Composition.categoryexampleDocumentClassValueSet
Composition.attester.moderequiredCompositionAttestationMode
Composition.attester:legal_attester.moderequiredPattern: legal
Composition.attester:notary_attester.moderequiredPattern: professional
Composition.attester:witness_attester.moderequiredPattern: personal
Composition.relatesTo.coderequiredDocumentRelationshipType
Composition.event.codeexampleActCode
Composition.section.codeexampleDocumentSectionCodes
Composition.section.moderequiredListMode
Composition.section.orderedBypreferredListOrderCodes
Composition.section.emptyReasonpreferredListEmptyReasons

Constraints

IdPathDetailsRequirements
cmp-1Composition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2Composition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()