CanShare models
0.1.0 - ci-build

CanShare models, published by David hay. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/davidhay25/models/ and changes regularly. See the Directory of published versions

Logical Model: DocumentDetails_cs - Detailed Descriptions

Draft as of 2024-03-04

Definitions for the DocumentDetails-cs logical model.

Guidance on how to interpret the contents of this table can be found here

0. DocumentDetails-cs
Definition

The identifying, versioning and descriptive details of a document.

ShortDocument details
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DocumentDetails-cs.DocumentId
Definition

A version-independent identifier for the document

ShortA version-independent identifier for the document
Control0..*
TypeIdentifier
4. DocumentDetails-cs.LocalDocumentIdentifier
Definition

A local identifier of the document that is unique only at the facility at which the document is created.

ShortA local identifier of the document that is unique only at the facility at which the document is created.
Control0..1
TypeIdentifier
6. DocumentDetails-cs.Version
Definition

An explicitly assigned identifier of a variation of the content in the document.

ShortAn explicitly assigned identifier of a variation of the content in the document.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. DocumentDetails-cs.Author
Definition

The healthcare practitioner who authored of the document.

ShortThe healthcare practitioner who authored of the document.
Control0..1
TypeBackboneElement
10. DocumentDetails-cs.Author.Id
Definition

HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker

ShortHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
Control0..1
TypeIdentifier
12. DocumentDetails-cs.Author.PersonName
Definition

Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.

ShortPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
Control0..1
TypeBackboneElement
14. DocumentDetails-cs.Author.PersonName.Title
Definition

The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person

ShortThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
Control0..1
TypeCodeableConcept
16. DocumentDetails-cs.Author.PersonName.GivenName
Definition

The person’s forename or given name at birth

ShortThe person’s forename or given name at birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. DocumentDetails-cs.Author.PersonName.FamilyName
Definition

The family name (surname) of a person as distinct from their given, second and subsequent name(s)

ShortThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. DocumentDetails-cs.Author.PersonName.NameProtectionFlag
Definition

This indicator denotes that the person’s name information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. DocumentDetails-cs.Author.PersonName.age
Definition

DocumentDetails.Author.PersonName.age

ShortDocumentDetails.Author.PersonName.age
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. DocumentDetails-cs.Author.ProfessionalRegistration
Definition

the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced

Shortthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
Control0..*
TypeBackboneElement
26. DocumentDetails-cs.Author.ProfessionalRegistration.AssigningOrganisationIdentifier
Definition

The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number

ShortThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
Control0..1
TypeCodeableConcept
28. DocumentDetails-cs.Author.HealthWorkerRole
Definition

The employment of a health worker in a specific role

ShortThe employment of a health worker in a specific role
Control0..1
TypeBackboneElement
30. DocumentDetails-cs.Author.HealthWorkerRole.PRI
Definition

A unique ten-character identifier assigned by the HPI system to an individual role

ShortA unique ten-character identifier assigned by the HPI system to an individual role
Control1..1
TypeIdentifier
32. DocumentDetails-cs.Author.HealthWorkerRole.RoleCode
Definition

The designated the role of a health worker

ShortThe designated the role of a health worker
Control1..1
TypeCodeableConcept
34. DocumentDetails-cs.Author.HealthWorkerRole.RoleConfidential
Definition

Whether or not the role of health care practitioner is confidential

ShortWhether or not the role of health care practitioner is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. DocumentDetails-cs.Author.HealthWorkerRole.FacilityId
Definition

The identifier of the healthcare facility at which the practitioner works in this role.

ShortThe identifier of the healthcare facility at which the practitioner works in this role.
Control0..1
TypeIdentifier
38. DocumentDetails-cs.AuthoredDate
Definition

The date on which this version of the document was authored.

ShortThe date on which this version of the document was authored.
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. DocumentDetails-cs.Status
Definition

The status of the document (as defined by HL7 FHIR)

ShortThe status of the document (as defined by HL7 FHIR)
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. DocumentDetails-cs.Category
Definition

The high-level kind of the document, e.g. pathology request, pathology report, treatment plan.

ShortThe high-level kind of the document, e.g. pathology request, pathology report, treatment plan.
Control0..*
TypeCodeableConcept
44. DocumentDetails-cs.Type
Definition

The specific type of document, e.g. breast pathology request for biopsy specimens

ShortThe specific type of document, e.g. breast pathology request for biopsy specimens
Control1..1
TypeCodeableConcept
46. DocumentDetails-cs.Encounter
Definition

The patient encounter associated with this document.

ShortThe patient encounter associated with this document.
Control0..1
TypeIdentifier

Guidance on how to interpret the contents of this table can be found here

0. DocumentDetails-cs
Definition

The identifying, versioning and descriptive details of a document.

ShortDocument details
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DocumentDetails-cs.DocumentId
Definition

A version-independent identifier for the document

ShortA version-independent identifier for the document
Control0..*
TypeIdentifier
4. DocumentDetails-cs.LocalDocumentIdentifier
Definition

A local identifier of the document that is unique only at the facility at which the document is created.

ShortA local identifier of the document that is unique only at the facility at which the document is created.
Control0..1
TypeIdentifier
6. DocumentDetails-cs.Version
Definition

An explicitly assigned identifier of a variation of the content in the document.

ShortAn explicitly assigned identifier of a variation of the content in the document.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. DocumentDetails-cs.Author
Definition

The healthcare practitioner who authored of the document.

ShortThe healthcare practitioner who authored of the document.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. DocumentDetails-cs.Author.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. DocumentDetails-cs.Author.Id
Definition

HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker

ShortHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
Control0..1
TypeIdentifier
14. DocumentDetails-cs.Author.PersonName
Definition

Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.

ShortPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. DocumentDetails-cs.Author.PersonName.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. DocumentDetails-cs.Author.PersonName.Title
Definition

The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person

ShortThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
Control0..1
TypeCodeableConcept
20. DocumentDetails-cs.Author.PersonName.GivenName
Definition

The person’s forename or given name at birth

ShortThe person’s forename or given name at birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. DocumentDetails-cs.Author.PersonName.FamilyName
Definition

The family name (surname) of a person as distinct from their given, second and subsequent name(s)

ShortThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. DocumentDetails-cs.Author.PersonName.NameProtectionFlag
Definition

This indicator denotes that the person’s name information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. DocumentDetails-cs.Author.PersonName.age
Definition

DocumentDetails.Author.PersonName.age

ShortDocumentDetails.Author.PersonName.age
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. DocumentDetails-cs.Author.ProfessionalRegistration
Definition

the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced

Shortthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. DocumentDetails-cs.Author.ProfessionalRegistration.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. DocumentDetails-cs.Author.ProfessionalRegistration.AssigningOrganisationIdentifier
Definition

The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number

ShortThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
Control0..1
TypeCodeableConcept
34. DocumentDetails-cs.Author.HealthWorkerRole
Definition

The employment of a health worker in a specific role

ShortThe employment of a health worker in a specific role
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. DocumentDetails-cs.Author.HealthWorkerRole.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. DocumentDetails-cs.Author.HealthWorkerRole.PRI
Definition

A unique ten-character identifier assigned by the HPI system to an individual role

ShortA unique ten-character identifier assigned by the HPI system to an individual role
Control1..1
TypeIdentifier
40. DocumentDetails-cs.Author.HealthWorkerRole.RoleCode
Definition

The designated the role of a health worker

ShortThe designated the role of a health worker
Control1..1
TypeCodeableConcept
42. DocumentDetails-cs.Author.HealthWorkerRole.RoleConfidential
Definition

Whether or not the role of health care practitioner is confidential

ShortWhether or not the role of health care practitioner is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. DocumentDetails-cs.Author.HealthWorkerRole.FacilityId
Definition

The identifier of the healthcare facility at which the practitioner works in this role.

ShortThe identifier of the healthcare facility at which the practitioner works in this role.
Control0..1
TypeIdentifier
46. DocumentDetails-cs.AuthoredDate
Definition

The date on which this version of the document was authored.

ShortThe date on which this version of the document was authored.
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. DocumentDetails-cs.Status
Definition

The status of the document (as defined by HL7 FHIR)

ShortThe status of the document (as defined by HL7 FHIR)
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
50. DocumentDetails-cs.Category
Definition

The high-level kind of the document, e.g. pathology request, pathology report, treatment plan.

ShortThe high-level kind of the document, e.g. pathology request, pathology report, treatment plan.
Control0..*
TypeCodeableConcept
52. DocumentDetails-cs.Type
Definition

The specific type of document, e.g. breast pathology request for biopsy specimens

ShortThe specific type of document, e.g. breast pathology request for biopsy specimens
Control1..1
TypeCodeableConcept
54. DocumentDetails-cs.Encounter
Definition

The patient encounter associated with this document.

ShortThe patient encounter associated with this document.
Control0..1
TypeIdentifier

Guidance on how to interpret the contents of this table can be found here

0. DocumentDetails-cs
Definition

The identifying, versioning and descriptive details of a document.

ShortDocument details
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DocumentDetails-cs.DocumentId
Definition

A version-independent identifier for the document

ShortA version-independent identifier for the document
Control0..*
TypeIdentifier
4. DocumentDetails-cs.LocalDocumentIdentifier
Definition

A local identifier of the document that is unique only at the facility at which the document is created.

ShortA local identifier of the document that is unique only at the facility at which the document is created.
Control0..1
TypeIdentifier
6. DocumentDetails-cs.Version
Definition

An explicitly assigned identifier of a variation of the content in the document.

ShortAn explicitly assigned identifier of a variation of the content in the document.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. DocumentDetails-cs.Author
Definition

The healthcare practitioner who authored of the document.

ShortThe healthcare practitioner who authored of the document.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. DocumentDetails-cs.Author.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
12. DocumentDetails-cs.Author.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DocumentDetails-cs.Author.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
14. DocumentDetails-cs.Author.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. DocumentDetails-cs.Author.Id
Definition

HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker

ShortHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
Control0..1
TypeIdentifier
18. DocumentDetails-cs.Author.PersonName
Definition

Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.

ShortPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. DocumentDetails-cs.Author.PersonName.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
22. DocumentDetails-cs.Author.PersonName.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DocumentDetails-cs.Author.PersonName.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
24. DocumentDetails-cs.Author.PersonName.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. DocumentDetails-cs.Author.PersonName.Title
Definition

The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person

ShortThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
Control0..1
TypeCodeableConcept
28. DocumentDetails-cs.Author.PersonName.GivenName
Definition

The person’s forename or given name at birth

ShortThe person’s forename or given name at birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. DocumentDetails-cs.Author.PersonName.FamilyName
Definition

The family name (surname) of a person as distinct from their given, second and subsequent name(s)

ShortThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. DocumentDetails-cs.Author.PersonName.NameProtectionFlag
Definition

This indicator denotes that the person’s name information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. DocumentDetails-cs.Author.PersonName.age
Definition

DocumentDetails.Author.PersonName.age

ShortDocumentDetails.Author.PersonName.age
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. DocumentDetails-cs.Author.ProfessionalRegistration
Definition

the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced

Shortthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. DocumentDetails-cs.Author.ProfessionalRegistration.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
40. DocumentDetails-cs.Author.ProfessionalRegistration.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DocumentDetails-cs.Author.ProfessionalRegistration.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
42. DocumentDetails-cs.Author.ProfessionalRegistration.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
44. DocumentDetails-cs.Author.ProfessionalRegistration.AssigningOrganisationIdentifier
Definition

The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number

ShortThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
Control0..1
TypeCodeableConcept
46. DocumentDetails-cs.Author.HealthWorkerRole
Definition

The employment of a health worker in a specific role

ShortThe employment of a health worker in a specific role
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. DocumentDetails-cs.Author.HealthWorkerRole.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
50. DocumentDetails-cs.Author.HealthWorkerRole.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DocumentDetails-cs.Author.HealthWorkerRole.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
52. DocumentDetails-cs.Author.HealthWorkerRole.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
54. DocumentDetails-cs.Author.HealthWorkerRole.PRI
Definition

A unique ten-character identifier assigned by the HPI system to an individual role

ShortA unique ten-character identifier assigned by the HPI system to an individual role
Control1..1
TypeIdentifier
56. DocumentDetails-cs.Author.HealthWorkerRole.RoleCode
Definition

The designated the role of a health worker

ShortThe designated the role of a health worker
Control1..1
TypeCodeableConcept
58. DocumentDetails-cs.Author.HealthWorkerRole.RoleConfidential
Definition

Whether or not the role of health care practitioner is confidential

ShortWhether or not the role of health care practitioner is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
60. DocumentDetails-cs.Author.HealthWorkerRole.FacilityId
Definition

The identifier of the healthcare facility at which the practitioner works in this role.

ShortThe identifier of the healthcare facility at which the practitioner works in this role.
Control0..1
TypeIdentifier
62. DocumentDetails-cs.AuthoredDate
Definition

The date on which this version of the document was authored.

ShortThe date on which this version of the document was authored.
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
64. DocumentDetails-cs.Status
Definition

The status of the document (as defined by HL7 FHIR)

ShortThe status of the document (as defined by HL7 FHIR)
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
66. DocumentDetails-cs.Category
Definition

The high-level kind of the document, e.g. pathology request, pathology report, treatment plan.

ShortThe high-level kind of the document, e.g. pathology request, pathology report, treatment plan.
Control0..*
TypeCodeableConcept
68. DocumentDetails-cs.Type
Definition

The specific type of document, e.g. breast pathology request for biopsy specimens

ShortThe specific type of document, e.g. breast pathology request for biopsy specimens
Control1..1
TypeCodeableConcept
70. DocumentDetails-cs.Encounter
Definition

The patient encounter associated with this document.

ShortThe patient encounter associated with this document.
Control0..1
TypeIdentifier