PACIO Advance Healthcare Directive Interoperability Implementation Guide
2.0.0-ballot - STU 2 – Ballot United States of America flag

PACIO Advance Healthcare Directive Interoperability Implementation Guide, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. 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: ADI Notary

Official URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-Notary Version: 2.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: ADINotary

This profile represents a person participating as a notary for a person's advance directives.

The ADI Notary profile uses the RelatedPerson Resource to represent the individual who plays the role of the Notary for patient who is completing their advance healthcare directive document. The code NOTARY is used to express the relationship this individual has to the patient. This coded value is used as a fixed value to encode this notary role, as an alternative to the concepts available in the PatientRelationship type value set.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
Constraints: us-core-14
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:NotaryInformationExtension 0..1 (Complex) Notary Information
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-notaryInformation-extension
... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(US Core Patient Profile) The patient this person is related to
... Slices for relationship SΣC 1..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by pattern:$this
Binding: PatientRelationshipType (extensible)
.... relationship:notary SΣC 1..1 CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NOTARY
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... name SΣC 1..1 HumanName A name associated with the person
... telecom SΣ 1..* ContactPoint A contact detail for the person
... address SΣ 0..* Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.relationship:notary Base preferred Patient relationship type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
us-core-14 error RelatedPerson Either a name or a relationship SHALL be provided (or both) name.exists() or relationship.exists()

This structure is derived from USCoreRelatedPersonProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
... text 1..1 Narrative Text summary of the resource, for human interpretation
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:NotaryInformationExtension 0..1 (Complex) Notary Information
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-notaryInformation-extension
... Slices for relationship 1..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by pattern:$this
Binding: PatientRelationshipType (extensible)
.... relationship:notary S 1..1 CodeableConcept The nature of the relationship
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NOTARY
... telecom 1..* ContactPoint A contact detail for the person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible Patient relationship type 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
Constraints: us-core-14
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:NotaryInformationExtension 0..1 (Complex) Notary Information
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-notaryInformation-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier A human identifier for this person
... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(US Core Patient Profile) The patient this person is related to
... Slices for relationship SΣC 1..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by pattern:$this
Binding: PatientRelationshipType (extensible)
.... relationship:notary SΣC 1..1 CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NOTARY
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... name SΣC 1..1 HumanName A name associated with the person
... telecom SΣ 1..* ContactPoint A contact detail for the person
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the related person was born
... address SΣ 0..* Address Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.relationship:notary Base preferred Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
us-core-14 error RelatedPerson Either a name or a relationship SHALL be provided (or both) name.exists() or relationship.exists()

This structure is derived from USCoreRelatedPersonProfile

Summary

Mandatory: 5 elements
Must-Support: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of RelatedPerson.relationship

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
Constraints: us-core-14
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:NotaryInformationExtension 0..1 (Complex) Notary Information
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-notaryInformation-extension
... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(US Core Patient Profile) The patient this person is related to
... Slices for relationship SΣC 1..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by pattern:$this
Binding: PatientRelationshipType (extensible)
.... relationship:notary SΣC 1..1 CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NOTARY
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... name SΣC 1..1 HumanName A name associated with the person
... telecom SΣ 1..* ContactPoint A contact detail for the person
... address SΣ 0..* Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.relationship:notary Base preferred Patient relationship type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
us-core-14 error RelatedPerson Either a name or a relationship SHALL be provided (or both) name.exists() or relationship.exists()

Differential View

This structure is derived from USCoreRelatedPersonProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
... text 1..1 Narrative Text summary of the resource, for human interpretation
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:NotaryInformationExtension 0..1 (Complex) Notary Information
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-notaryInformation-extension
... Slices for relationship 1..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by pattern:$this
Binding: PatientRelationshipType (extensible)
.... relationship:notary S 1..1 CodeableConcept The nature of the relationship
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NOTARY
... telecom 1..* ContactPoint A contact detail for the person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible Patient relationship type 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
Constraints: us-core-14
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:NotaryInformationExtension 0..1 (Complex) Notary Information
URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-notaryInformation-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier A human identifier for this person
... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(US Core Patient Profile) The patient this person is related to
... Slices for relationship SΣC 1..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by pattern:$this
Binding: PatientRelationshipType (extensible)
.... relationship:notary SΣC 1..1 CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NOTARY
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... name SΣC 1..1 HumanName A name associated with the person
... telecom SΣ 1..* ContactPoint A contact detail for the person
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the related person was born
... address SΣ 0..* Address Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.relationship:notary Base preferred Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
us-core-14 error RelatedPerson Either a name or a relationship SHALL be provided (or both) name.exists() or relationship.exists()

This structure is derived from USCoreRelatedPersonProfile

Summary

Mandatory: 5 elements
Must-Support: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of RelatedPerson.relationship

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron