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: Document details

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:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentDetails-cs 0..*BaseDocument details
Instances of this logical model are not marked to be the target of a Reference
... DocumentId 0..*IdentifierA version-independent identifier for the document
... LocalDocumentIdentifier 0..1IdentifierA local identifier of the document that is unique only at the facility at which the document is created.
... Version 0..1stringAn explicitly assigned identifier of a variation of the content in the document.
.... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
.... PersonName 0..1BackboneElementPerson 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..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
..... GivenName 0..1stringThe person’s forename or given name at birth
..... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
..... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
..... age 0..1stringDocumentDetails.Author.PersonName.age
.... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
..... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
.... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
..... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
..... RoleCode 1..1CodeableConceptThe designated the role of a health worker
..... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
..... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
... AuthoredDate 0..1dateTimeThe date on which this version of the document was authored.
... Status 1..1codeThe status of the document (as defined by HL7 FHIR)
... Category 0..*CodeableConceptThe high-level kind of the document, e.g. pathology request, pathology report, treatment plan.
... Type 1..1CodeableConceptThe specific type of document, e.g. breast pathology request for biopsy specimens
... Encounter 0..1IdentifierThe patient encounter associated with this document.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentDetails-cs 0..*BaseDocument details
Instances of this logical model are not marked to be the target of a Reference
... DocumentId 0..*IdentifierA version-independent identifier for the document
... LocalDocumentIdentifier 0..1IdentifierA local identifier of the document that is unique only at the facility at which the document is created.
... Version 0..1stringAn explicitly assigned identifier of a variation of the content in the document.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
.... PersonName 0..1BackboneElementPerson 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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
..... GivenName 0..1stringThe person’s forename or given name at birth
..... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
..... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
..... age 0..1stringDocumentDetails.Author.PersonName.age
.... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
.... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
..... RoleCode 1..1CodeableConceptThe designated the role of a health worker
..... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
..... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
... AuthoredDate 0..1dateTimeThe date on which this version of the document was authored.
... Status 1..1codeThe status of the document (as defined by HL7 FHIR)
... Category 0..*CodeableConceptThe high-level kind of the document, e.g. pathology request, pathology report, treatment plan.
... Type 1..1CodeableConceptThe specific type of document, e.g. breast pathology request for biopsy specimens
... Encounter 0..1IdentifierThe patient encounter associated with this document.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentDetails-cs 0..*BaseDocument details
Instances of this logical model are not marked to be the target of a Reference
... DocumentId 0..*IdentifierA version-independent identifier for the document
... LocalDocumentIdentifier 0..1IdentifierA local identifier of the document that is unique only at the facility at which the document is created.
... Version 0..1stringAn explicitly assigned identifier of a variation of the content in the document.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
.... PersonName 0..1BackboneElementPerson 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
..... GivenName 0..1stringThe person’s forename or given name at birth
..... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
..... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
..... age 0..1stringDocumentDetails.Author.PersonName.age
.... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
.... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
..... RoleCode 1..1CodeableConceptThe designated the role of a health worker
..... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
..... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
... AuthoredDate 0..1dateTimeThe date on which this version of the document was authored.
... Status 1..1codeThe status of the document (as defined by HL7 FHIR)
... Category 0..*CodeableConceptThe high-level kind of the document, e.g. pathology request, pathology report, treatment plan.
... Type 1..1CodeableConceptThe specific type of document, e.g. breast pathology request for biopsy specimens
... Encounter 0..1IdentifierThe patient encounter associated with this document.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (4 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentDetails-cs 0..*BaseDocument details
Instances of this logical model are not marked to be the target of a Reference
... DocumentId 0..*IdentifierA version-independent identifier for the document
... LocalDocumentIdentifier 0..1IdentifierA local identifier of the document that is unique only at the facility at which the document is created.
... Version 0..1stringAn explicitly assigned identifier of a variation of the content in the document.
.... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
.... PersonName 0..1BackboneElementPerson 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..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
..... GivenName 0..1stringThe person’s forename or given name at birth
..... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
..... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
..... age 0..1stringDocumentDetails.Author.PersonName.age
.... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
..... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
.... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
..... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
..... RoleCode 1..1CodeableConceptThe designated the role of a health worker
..... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
..... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
... AuthoredDate 0..1dateTimeThe date on which this version of the document was authored.
... Status 1..1codeThe status of the document (as defined by HL7 FHIR)
... Category 0..*CodeableConceptThe high-level kind of the document, e.g. pathology request, pathology report, treatment plan.
... Type 1..1CodeableConceptThe specific type of document, e.g. breast pathology request for biopsy specimens
... Encounter 0..1IdentifierThe patient encounter associated with this document.

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentDetails-cs 0..*BaseDocument details
Instances of this logical model are not marked to be the target of a Reference
... DocumentId 0..*IdentifierA version-independent identifier for the document
... LocalDocumentIdentifier 0..1IdentifierA local identifier of the document that is unique only at the facility at which the document is created.
... Version 0..1stringAn explicitly assigned identifier of a variation of the content in the document.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
.... PersonName 0..1BackboneElementPerson 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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
..... GivenName 0..1stringThe person’s forename or given name at birth
..... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
..... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
..... age 0..1stringDocumentDetails.Author.PersonName.age
.... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
.... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
..... RoleCode 1..1CodeableConceptThe designated the role of a health worker
..... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
..... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
... AuthoredDate 0..1dateTimeThe date on which this version of the document was authored.
... Status 1..1codeThe status of the document (as defined by HL7 FHIR)
... Category 0..*CodeableConceptThe high-level kind of the document, e.g. pathology request, pathology report, treatment plan.
... Type 1..1CodeableConceptThe specific type of document, e.g. breast pathology request for biopsy specimens
... Encounter 0..1IdentifierThe patient encounter associated with this document.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentDetails-cs 0..*BaseDocument details
Instances of this logical model are not marked to be the target of a Reference
... DocumentId 0..*IdentifierA version-independent identifier for the document
... LocalDocumentIdentifier 0..1IdentifierA local identifier of the document that is unique only at the facility at which the document is created.
... Version 0..1stringAn explicitly assigned identifier of a variation of the content in the document.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
.... PersonName 0..1BackboneElementPerson 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
..... GivenName 0..1stringThe person’s forename or given name at birth
..... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
..... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
..... age 0..1stringDocumentDetails.Author.PersonName.age
.... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
.... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
..... RoleCode 1..1CodeableConceptThe designated the role of a health worker
..... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
..... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
... AuthoredDate 0..1dateTimeThe date on which this version of the document was authored.
... Status 1..1codeThe status of the document (as defined by HL7 FHIR)
... Category 0..*CodeableConceptThe high-level kind of the document, e.g. pathology request, pathology report, treatment plan.
... Type 1..1CodeableConceptThe specific type of document, e.g. breast pathology request for biopsy specimens
... Encounter 0..1IdentifierThe patient encounter associated with this document.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (4 nested mandatory elements)

 

Other representations of profile: CSV, Excel