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
Official URL: http://example.org/StructureDefinition/DocumentDetails-cs | Version: 0.1.0 | |||
Draft as of 2024-03-04 | Computable Name: DocumentDetails_cs |
The identifying, versioning and descriptive details of a document.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentDetails-cs | 0..* | Base | Document details Instances of this logical model are not marked to be the target of a Reference | |
DocumentId | 0..* | Identifier | A version-independent identifier for the document | |
LocalDocumentIdentifier | 0..1 | Identifier | A local identifier of the document that is unique only at the facility at which the document is created. | |
Version | 0..1 | string | An explicitly assigned identifier of a variation of the content in the document. | |
Author | 0..1 | BackboneElement | The healthcare practitioner who authored of the document. | |
Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
PersonName | 0..1 | BackboneElement | 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. | |
Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
GivenName | 0..1 | string | The person’s forename or given name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | DocumentDetails.Author.PersonName.age | |
ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
AuthoredDate | 0..1 | dateTime | The date on which this version of the document was authored. | |
Status | 1..1 | code | The status of the document (as defined by HL7 FHIR) | |
Category | 0..* | CodeableConcept | The high-level kind of the document, e.g. pathology request, pathology report, treatment plan. | |
Type | 1..1 | CodeableConcept | The specific type of document, e.g. breast pathology request for biopsy specimens | |
Encounter | 0..1 | Identifier | The patient encounter associated with this document. | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentDetails-cs | 0..* | Base | Document details Instances of this logical model are not marked to be the target of a Reference | |
DocumentId | 0..* | Identifier | A version-independent identifier for the document | |
LocalDocumentIdentifier | 0..1 | Identifier | A local identifier of the document that is unique only at the facility at which the document is created. | |
Version | 0..1 | string | An explicitly assigned identifier of a variation of the content in the document. | |
Author | 0..1 | BackboneElement | The healthcare practitioner who authored of the document. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
PersonName | 0..1 | BackboneElement | 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. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
GivenName | 0..1 | string | The person’s forename or given name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | DocumentDetails.Author.PersonName.age | |
ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
AuthoredDate | 0..1 | dateTime | The date on which this version of the document was authored. | |
Status | 1..1 | code | The status of the document (as defined by HL7 FHIR) | |
Category | 0..* | CodeableConcept | The high-level kind of the document, e.g. pathology request, pathology report, treatment plan. | |
Type | 1..1 | CodeableConcept | The specific type of document, e.g. breast pathology request for biopsy specimens | |
Encounter | 0..1 | Identifier | The patient encounter associated with this document. | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentDetails-cs | 0..* | Base | Document details Instances of this logical model are not marked to be the target of a Reference | |
DocumentId | 0..* | Identifier | A version-independent identifier for the document | |
LocalDocumentIdentifier | 0..1 | Identifier | A local identifier of the document that is unique only at the facility at which the document is created. | |
Version | 0..1 | string | An explicitly assigned identifier of a variation of the content in the document. | |
Author | 0..1 | BackboneElement | The healthcare practitioner who authored of the document. | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
PersonName | 0..1 | BackboneElement | 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. | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
GivenName | 0..1 | string | The person’s forename or given name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | DocumentDetails.Author.PersonName.age | |
ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
AuthoredDate | 0..1 | dateTime | The date on which this version of the document was authored. | |
Status | 1..1 | code | The status of the document (as defined by HL7 FHIR) | |
Category | 0..* | CodeableConcept | The high-level kind of the document, e.g. pathology request, pathology report, treatment plan. | |
Type | 1..1 | CodeableConcept | The specific type of document, e.g. breast pathology request for biopsy specimens | |
Encounter | 0..1 | Identifier | The patient encounter associated with this document. | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from Base
Differential View
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentDetails-cs | 0..* | Base | Document details Instances of this logical model are not marked to be the target of a Reference | |
DocumentId | 0..* | Identifier | A version-independent identifier for the document | |
LocalDocumentIdentifier | 0..1 | Identifier | A local identifier of the document that is unique only at the facility at which the document is created. | |
Version | 0..1 | string | An explicitly assigned identifier of a variation of the content in the document. | |
Author | 0..1 | BackboneElement | The healthcare practitioner who authored of the document. | |
Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
PersonName | 0..1 | BackboneElement | 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. | |
Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
GivenName | 0..1 | string | The person’s forename or given name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | DocumentDetails.Author.PersonName.age | |
ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
AuthoredDate | 0..1 | dateTime | The date on which this version of the document was authored. | |
Status | 1..1 | code | The status of the document (as defined by HL7 FHIR) | |
Category | 0..* | CodeableConcept | The high-level kind of the document, e.g. pathology request, pathology report, treatment plan. | |
Type | 1..1 | CodeableConcept | The specific type of document, e.g. breast pathology request for biopsy specimens | |
Encounter | 0..1 | Identifier | The patient encounter associated with this document. | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentDetails-cs | 0..* | Base | Document details Instances of this logical model are not marked to be the target of a Reference | |
DocumentId | 0..* | Identifier | A version-independent identifier for the document | |
LocalDocumentIdentifier | 0..1 | Identifier | A local identifier of the document that is unique only at the facility at which the document is created. | |
Version | 0..1 | string | An explicitly assigned identifier of a variation of the content in the document. | |
Author | 0..1 | BackboneElement | The healthcare practitioner who authored of the document. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
PersonName | 0..1 | BackboneElement | 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. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
GivenName | 0..1 | string | The person’s forename or given name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | DocumentDetails.Author.PersonName.age | |
ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
AuthoredDate | 0..1 | dateTime | The date on which this version of the document was authored. | |
Status | 1..1 | code | The status of the document (as defined by HL7 FHIR) | |
Category | 0..* | CodeableConcept | The high-level kind of the document, e.g. pathology request, pathology report, treatment plan. | |
Type | 1..1 | CodeableConcept | The specific type of document, e.g. breast pathology request for biopsy specimens | |
Encounter | 0..1 | Identifier | The patient encounter associated with this document. | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentDetails-cs | 0..* | Base | Document details Instances of this logical model are not marked to be the target of a Reference | |
DocumentId | 0..* | Identifier | A version-independent identifier for the document | |
LocalDocumentIdentifier | 0..1 | Identifier | A local identifier of the document that is unique only at the facility at which the document is created. | |
Version | 0..1 | string | An explicitly assigned identifier of a variation of the content in the document. | |
Author | 0..1 | BackboneElement | The healthcare practitioner who authored of the document. | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
PersonName | 0..1 | BackboneElement | 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. | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
GivenName | 0..1 | string | The person’s forename or given name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | DocumentDetails.Author.PersonName.age | |
ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
AuthoredDate | 0..1 | dateTime | The date on which this version of the document was authored. | |
Status | 1..1 | code | The status of the document (as defined by HL7 FHIR) | |
Category | 0..* | CodeableConcept | The high-level kind of the document, e.g. pathology request, pathology report, treatment plan. | |
Type | 1..1 | CodeableConcept | The specific type of document, e.g. breast pathology request for biopsy specimens | |
Encounter | 0..1 | Identifier | The patient encounter associated with this document. | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from Base