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: ReferralPathway_cs - Detailed Descriptions

Draft as of 2024-03-04

Definitions for the ReferralPathway-cs logical model.

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

0. ReferralPathway-cs
Definition

The pathway by which the patient was referred for the given service.

ShortReferral pathway
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ReferralPathway-cs.PathwayType
Definition

The method or programme that led to this service request, e.g. screening, surveillance, diagnostic, acute.

ShortThe method or programme that led to this service request, e.g. screening, surveillance, diagnostic, acute.
Control1..1
TypeCodeableConcept
4. ReferralPathway-cs.ReferralCriteria
Definition

The applicable referral criteria that apply to each referral criteria set.

ShortThe applicable referral criteria that apply to each referral criteria set.
Control0..*
TypeBackboneElement
6. ReferralPathway-cs.ReferralCriteria.ReferralCriteriaSet
Definition

The set of criteria used to refer the patient for this service, e.g. 'Ministry of Health Referral criteria for Outpatient Colonoscopy (2 week category)'

ShortThe set of criteria used to refer the patient for this service, e.g. 'Ministry of Health Referral criteria for Outpatient Colonoscopy (2 week category)'
Control0..1
TypeCodeableConcept
8. ReferralPathway-cs.ReferralCriteria.ApplicableCriteria
Definition

The criteria (optionally from a predefined referral criteria set) that is applicable to this patient.

ShortThe criteria (optionally from a predefined referral criteria set) that is applicable to this patient.
Control0..*
TypeBackboneElement
10. ReferralPathway-cs.ReferralCriteria.ApplicableCriteria.ApplicableCriteriaType
Definition

The criteria type (optionally from a predefined referral criteria set) that is applicable to this patient.

ShortThe criteria type (optionally from a predefined referral criteria set) that is applicable to this patient.
Control1..1
TypeCodeableConcept
12. ReferralPathway-cs.ReferralCriteria.ApplicableCriteria.ApplicableCriteriaSubtype
Definition

A subtype of the criteria type (optionally from a predefined referral criteria set) that is applicable to this patient.

ShortA subtype of the criteria type (optionally from a predefined referral criteria set) that is applicable to this patient.
Control0..1
TypeCodeableConcept
14. ReferralPathway-cs.ReferralCriteria.Comments
Definition

Additional free text comments about the referral criteria.

ShortAdditional free text comments about the referral criteria.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. ReferralPathway-cs.NationalScreeningProgramme
Definition

Details about the patient's journey in the national screening programme.

ShortDetails about the patient's journey in the national screening programme.
Control0..1
TypeBackboneElement
18. ReferralPathway-cs.NationalScreeningProgramme.NSPType
Definition

The type of national screening programme, e.g. National bowel screening programme, National breast screening programme.

ShortThe type of national screening programme, e.g. National bowel screening programme, National breast screening programme.
Control1..1
TypeCodeableConcept
20. ReferralPathway-cs.NationalScreeningProgramme.CancerDetectedInNSP
Definition

Whether or not the cancer was detected via a national screening programme.

ShortWhether or not the cancer was detected via a national screening programme.
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. ReferralPathway-cs
Definition

The pathway by which the patient was referred for the given service.

ShortReferral pathway
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ReferralPathway-cs.PathwayType
Definition

The method or programme that led to this service request, e.g. screening, surveillance, diagnostic, acute.

ShortThe method or programme that led to this service request, e.g. screening, surveillance, diagnostic, acute.
Control1..1
TypeCodeableConcept
4. ReferralPathway-cs.ReferralCriteria
Definition

The applicable referral criteria that apply to each referral criteria set.

ShortThe applicable referral criteria that apply to each referral criteria set.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. ReferralPathway-cs.ReferralCriteria.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The set of criteria used to refer the patient for this service, e.g. 'Ministry of Health Referral criteria for Outpatient Colonoscopy (2 week category)'

ShortThe set of criteria used to refer the patient for this service, e.g. 'Ministry of Health Referral criteria for Outpatient Colonoscopy (2 week category)'
Control0..1
TypeCodeableConcept
10. ReferralPathway-cs.ReferralCriteria.ApplicableCriteria
Definition

The criteria (optionally from a predefined referral criteria set) that is applicable to this patient.

ShortThe criteria (optionally from a predefined referral criteria set) that is applicable to this patient.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. ReferralPathway-cs.ReferralCriteria.ApplicableCriteria.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The criteria type (optionally from a predefined referral criteria set) that is applicable to this patient.

ShortThe criteria type (optionally from a predefined referral criteria set) that is applicable to this patient.
Control1..1
TypeCodeableConcept
16. ReferralPathway-cs.ReferralCriteria.ApplicableCriteria.ApplicableCriteriaSubtype
Definition

A subtype of the criteria type (optionally from a predefined referral criteria set) that is applicable to this patient.

ShortA subtype of the criteria type (optionally from a predefined referral criteria set) that is applicable to this patient.
Control0..1
TypeCodeableConcept
18. ReferralPathway-cs.ReferralCriteria.Comments
Definition

Additional free text comments about the referral criteria.

ShortAdditional free text comments about the referral criteria.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. ReferralPathway-cs.NationalScreeningProgramme
Definition

Details about the patient's journey in the national screening programme.

ShortDetails about the patient's journey in the national screening programme.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. ReferralPathway-cs.NationalScreeningProgramme.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The type of national screening programme, e.g. National bowel screening programme, National breast screening programme.

ShortThe type of national screening programme, e.g. National bowel screening programme, National breast screening programme.
Control1..1
TypeCodeableConcept
26. ReferralPathway-cs.NationalScreeningProgramme.CancerDetectedInNSP
Definition

Whether or not the cancer was detected via a national screening programme.

ShortWhether or not the cancer was detected via a national screening programme.
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. ReferralPathway-cs
Definition

The pathway by which the patient was referred for the given service.

ShortReferral pathway
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ReferralPathway-cs.PathwayType
Definition

The method or programme that led to this service request, e.g. screening, surveillance, diagnostic, acute.

ShortThe method or programme that led to this service request, e.g. screening, surveillance, diagnostic, acute.
Control1..1
TypeCodeableConcept
4. ReferralPathway-cs.ReferralCriteria
Definition

The applicable referral criteria that apply to each referral criteria set.

ShortThe applicable referral criteria that apply to each referral criteria set.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. ReferralPathway-cs.ReferralCriteria.id
Definition

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

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

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

ShortAdditional content defined by implementations
Comments

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

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

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The set of criteria used to refer the patient for this service, e.g. 'Ministry of Health Referral criteria for Outpatient Colonoscopy (2 week category)'

ShortThe set of criteria used to refer the patient for this service, e.g. 'Ministry of Health Referral criteria for Outpatient Colonoscopy (2 week category)'
Control0..1
TypeCodeableConcept
14. ReferralPathway-cs.ReferralCriteria.ApplicableCriteria
Definition

The criteria (optionally from a predefined referral criteria set) that is applicable to this patient.

ShortThe criteria (optionally from a predefined referral criteria set) that is applicable to this patient.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. ReferralPathway-cs.ReferralCriteria.ApplicableCriteria.id
Definition

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

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

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

ShortAdditional content defined by implementations
Comments

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

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

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The criteria type (optionally from a predefined referral criteria set) that is applicable to this patient.

ShortThe criteria type (optionally from a predefined referral criteria set) that is applicable to this patient.
Control1..1
TypeCodeableConcept
24. ReferralPathway-cs.ReferralCriteria.ApplicableCriteria.ApplicableCriteriaSubtype
Definition

A subtype of the criteria type (optionally from a predefined referral criteria set) that is applicable to this patient.

ShortA subtype of the criteria type (optionally from a predefined referral criteria set) that is applicable to this patient.
Control0..1
TypeCodeableConcept
26. ReferralPathway-cs.ReferralCriteria.Comments
Definition

Additional free text comments about the referral criteria.

ShortAdditional free text comments about the referral criteria.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. ReferralPathway-cs.NationalScreeningProgramme
Definition

Details about the patient's journey in the national screening programme.

ShortDetails about the patient's journey in the national screening programme.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. ReferralPathway-cs.NationalScreeningProgramme.id
Definition

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

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

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

ShortAdditional content defined by implementations
Comments

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

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

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The type of national screening programme, e.g. National bowel screening programme, National breast screening programme.

ShortThe type of national screening programme, e.g. National bowel screening programme, National breast screening programme.
Control1..1
TypeCodeableConcept
38. ReferralPathway-cs.NationalScreeningProgramme.CancerDetectedInNSP
Definition

Whether or not the cancer was detected via a national screening programme.

ShortWhether or not the cancer was detected via a national screening programme.
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension