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: Clinical staging (colorectal histopathology request)

Official URL: http://example.org/StructureDefinition/ColorectalHistoRequestClinicalStaging-cs Version: 0.1.0
Draft as of 2024-03-04 Computable Name: ColorectalHistoRequestClinicalStaging_cs

Clinical TNM staging for colorectal cancers, including adenocarcinomas, high-grade neuroendocrine carcinomas, and squamous carcinomas of the colon.

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
.. ColorectalHistoRequestClinicalStaging-cs 0..*BaseClinical staging (colorectal histopathology request)
Instances of this logical model are not marked to be the target of a Reference
... ClinicalTnmStage 1..1BackboneElementClinical TNM staging for colorectal cancers, including adenocarcinomas, high-grade neuroendocrine carcinomas, and squamous carcinomas of the colon.
.... System 1..1CodeableConceptThe cancer staging system used to stage the colorectal cancer.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system (preferred)
.... Date 0..1dateThe date on which the staging was performed.
.... Type 1..1CodeableConceptThe type of staging performed, e.g. Clinical stage, Pathological stage
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification (preferred)
.... Descriptor 0..*CodeableConceptA prefix or suffix applicable to the given staging.
.... Component 0..*BackboneElementA component, factor or criteria that is used to calculate the stage.
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
..... Date 0..1dateTimeThe date and/or time that the observation was performed.
..... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
...... 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..1stringColorectalHistoRequestClinicalStaging.ClinicalTnmStage.Component.PerformedBy.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.
..... Comments 0..1stringPlain text comments about the observation.
..... CTCategory 0..1BackboneElementThe clinical stage classification of the primary tumour, based on patient history, physical examination, and any imaging done before initiation of treatment.
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical T value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct (preferred)
..... CNCategory 0..1BackboneElementThe clinical stage classification of regional lymph nodes, based on patient history, physical examination, and any imaging done before initiation of treatment.
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical N value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn (preferred)
..... CMCategory 0..1BackboneElementA component, factor or criteria that is used to calculate the stage.
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical M value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm (preferred)
.... Stage 0..1CodeableConceptThe stage group used to determine the prognosis of the patient's cancer.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group (preferred)
.... Comments 0..1stringFree text comments about the cancer staging.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Systempreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Typepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CTCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CNCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CMCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Stagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group
NameFlagsCard.TypeDescription & Constraintsdoco
.. ColorectalHistoRequestClinicalStaging-cs 0..*BaseClinical staging (colorectal histopathology request)
Instances of this logical model are not marked to be the target of a Reference
... ClinicalTnmStage 1..1BackboneElementClinical TNM staging for colorectal cancers, including adenocarcinomas, high-grade neuroendocrine carcinomas, and squamous carcinomas of the colon.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... System 1..1CodeableConceptThe cancer staging system used to stage the colorectal cancer.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system (preferred)
.... Date 0..1dateThe date on which the staging was performed.
.... Type 1..1CodeableConceptThe type of staging performed, e.g. Clinical stage, Pathological stage
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification (preferred)
.... Descriptor 0..*CodeableConceptA prefix or suffix applicable to the given staging.
.... Component 0..*BackboneElementA component, factor or criteria that is used to calculate the stage.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
..... Date 0..1dateTimeThe date and/or time that the observation was performed.
..... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
...... 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..1stringColorectalHistoRequestClinicalStaging.ClinicalTnmStage.Component.PerformedBy.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.
..... Comments 0..1stringPlain text comments about the observation.
..... CTCategory 0..1BackboneElementThe clinical stage classification of the primary tumour, based on patient history, physical examination, and any imaging done before initiation of treatment.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical T value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct (preferred)
..... CNCategory 0..1BackboneElementThe clinical stage classification of regional lymph nodes, based on patient history, physical examination, and any imaging done before initiation of treatment.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical N value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn (preferred)
..... CMCategory 0..1BackboneElementA component, factor or criteria that is used to calculate the stage.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical M value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm (preferred)
.... Stage 0..1CodeableConceptThe stage group used to determine the prognosis of the patient's cancer.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group (preferred)
.... Comments 0..1stringFree text comments about the cancer staging.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Systempreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Typepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CTCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CNCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CMCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Stagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group

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
.. ColorectalHistoRequestClinicalStaging-cs 0..*BaseClinical staging (colorectal histopathology request)
Instances of this logical model are not marked to be the target of a Reference
... ClinicalTnmStage 1..1BackboneElementClinical TNM staging for colorectal cancers, including adenocarcinomas, high-grade neuroendocrine carcinomas, and squamous carcinomas of the colon.
.... @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
.... System 1..1CodeableConceptThe cancer staging system used to stage the colorectal cancer.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system (preferred)
.... Date 0..1dateThe date on which the staging was performed.
.... Type 1..1CodeableConceptThe type of staging performed, e.g. Clinical stage, Pathological stage
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification (preferred)
.... Descriptor 0..*CodeableConceptA prefix or suffix applicable to the given staging.
.... Component 0..*BackboneElementA component, factor or criteria that is used to calculate the stage.
..... @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
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
..... Date 0..1dateTimeThe date and/or time that the observation was performed.
..... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
...... @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..1stringColorectalHistoRequestClinicalStaging.ClinicalTnmStage.Component.PerformedBy.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.
..... Comments 0..1stringPlain text comments about the observation.
..... CTCategory 0..1BackboneElementThe clinical stage classification of the primary tumour, based on patient history, physical examination, and any imaging done before initiation of treatment.
...... @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
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical T value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct (preferred)
..... CNCategory 0..1BackboneElementThe clinical stage classification of regional lymph nodes, based on patient history, physical examination, and any imaging done before initiation of treatment.
...... @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
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical N value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn (preferred)
..... CMCategory 0..1BackboneElementA component, factor or criteria that is used to calculate the stage.
...... @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
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical M value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm (preferred)
.... Stage 0..1CodeableConceptThe stage group used to determine the prognosis of the patient's cancer.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group (preferred)
.... Comments 0..1stringFree text comments about the cancer staging.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Systempreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Typepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CTCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CNCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CMCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Stagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group

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 (13 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ColorectalHistoRequestClinicalStaging-cs 0..*BaseClinical staging (colorectal histopathology request)
Instances of this logical model are not marked to be the target of a Reference
... ClinicalTnmStage 1..1BackboneElementClinical TNM staging for colorectal cancers, including adenocarcinomas, high-grade neuroendocrine carcinomas, and squamous carcinomas of the colon.
.... System 1..1CodeableConceptThe cancer staging system used to stage the colorectal cancer.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system (preferred)
.... Date 0..1dateThe date on which the staging was performed.
.... Type 1..1CodeableConceptThe type of staging performed, e.g. Clinical stage, Pathological stage
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification (preferred)
.... Descriptor 0..*CodeableConceptA prefix or suffix applicable to the given staging.
.... Component 0..*BackboneElementA component, factor or criteria that is used to calculate the stage.
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
..... Date 0..1dateTimeThe date and/or time that the observation was performed.
..... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
...... 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..1stringColorectalHistoRequestClinicalStaging.ClinicalTnmStage.Component.PerformedBy.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.
..... Comments 0..1stringPlain text comments about the observation.
..... CTCategory 0..1BackboneElementThe clinical stage classification of the primary tumour, based on patient history, physical examination, and any imaging done before initiation of treatment.
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical T value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct (preferred)
..... CNCategory 0..1BackboneElementThe clinical stage classification of regional lymph nodes, based on patient history, physical examination, and any imaging done before initiation of treatment.
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical N value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn (preferred)
..... CMCategory 0..1BackboneElementA component, factor or criteria that is used to calculate the stage.
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical M value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm (preferred)
.... Stage 0..1CodeableConceptThe stage group used to determine the prognosis of the patient's cancer.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group (preferred)
.... Comments 0..1stringFree text comments about the cancer staging.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Systempreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Typepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CTCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CNCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CMCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Stagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ColorectalHistoRequestClinicalStaging-cs 0..*BaseClinical staging (colorectal histopathology request)
Instances of this logical model are not marked to be the target of a Reference
... ClinicalTnmStage 1..1BackboneElementClinical TNM staging for colorectal cancers, including adenocarcinomas, high-grade neuroendocrine carcinomas, and squamous carcinomas of the colon.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... System 1..1CodeableConceptThe cancer staging system used to stage the colorectal cancer.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system (preferred)
.... Date 0..1dateThe date on which the staging was performed.
.... Type 1..1CodeableConceptThe type of staging performed, e.g. Clinical stage, Pathological stage
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification (preferred)
.... Descriptor 0..*CodeableConceptA prefix or suffix applicable to the given staging.
.... Component 0..*BackboneElementA component, factor or criteria that is used to calculate the stage.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
..... Date 0..1dateTimeThe date and/or time that the observation was performed.
..... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
...... 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..1stringColorectalHistoRequestClinicalStaging.ClinicalTnmStage.Component.PerformedBy.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.
..... Comments 0..1stringPlain text comments about the observation.
..... CTCategory 0..1BackboneElementThe clinical stage classification of the primary tumour, based on patient history, physical examination, and any imaging done before initiation of treatment.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical T value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct (preferred)
..... CNCategory 0..1BackboneElementThe clinical stage classification of regional lymph nodes, based on patient history, physical examination, and any imaging done before initiation of treatment.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical N value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn (preferred)
..... CMCategory 0..1BackboneElementA component, factor or criteria that is used to calculate the stage.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical M value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm (preferred)
.... Stage 0..1CodeableConceptThe stage group used to determine the prognosis of the patient's cancer.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group (preferred)
.... Comments 0..1stringFree text comments about the cancer staging.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Systempreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Typepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CTCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CNCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CMCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Stagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group

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
.. ColorectalHistoRequestClinicalStaging-cs 0..*BaseClinical staging (colorectal histopathology request)
Instances of this logical model are not marked to be the target of a Reference
... ClinicalTnmStage 1..1BackboneElementClinical TNM staging for colorectal cancers, including adenocarcinomas, high-grade neuroendocrine carcinomas, and squamous carcinomas of the colon.
.... @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
.... System 1..1CodeableConceptThe cancer staging system used to stage the colorectal cancer.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system (preferred)
.... Date 0..1dateThe date on which the staging was performed.
.... Type 1..1CodeableConceptThe type of staging performed, e.g. Clinical stage, Pathological stage
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification (preferred)
.... Descriptor 0..*CodeableConceptA prefix or suffix applicable to the given staging.
.... Component 0..*BackboneElementA component, factor or criteria that is used to calculate the stage.
..... @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
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
..... Date 0..1dateTimeThe date and/or time that the observation was performed.
..... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
...... @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..1stringColorectalHistoRequestClinicalStaging.ClinicalTnmStage.Component.PerformedBy.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.
..... Comments 0..1stringPlain text comments about the observation.
..... CTCategory 0..1BackboneElementThe clinical stage classification of the primary tumour, based on patient history, physical examination, and any imaging done before initiation of treatment.
...... @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
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical T value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct (preferred)
..... CNCategory 0..1BackboneElementThe clinical stage classification of regional lymph nodes, based on patient history, physical examination, and any imaging done before initiation of treatment.
...... @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
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical N value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn (preferred)
..... CMCategory 0..1BackboneElementA component, factor or criteria that is used to calculate the stage.
...... @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
...... Code 1..1CodeableConceptThe type of observation made.
...... Value 1..1CodeableConceptThe TNM clinical M value.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm (preferred)
.... Stage 0..1CodeableConceptThe stage group used to determine the prognosis of the patient's cancer.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group (preferred)
.... Comments 0..1stringFree text comments about the cancer staging.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Systempreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ajcc-staging-system
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Typepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-ctnm-stage-classification
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CTCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-ct
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CNCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cn
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Component.CMCategory.Valuepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-gi-colorectal-cm
ColorectalHistoRequestClinicalStaging-cs.ClinicalTnmStage.Stagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-tnm-colorectal-stage-group

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 (13 nested mandatory elements)

 

Other representations of profile: CSV, Excel