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: Ancillary studies (breast)
| Official URL: http://example.org/StructureDefinition/AncillaryStudiesBreast-cs | Version: 0.1.0 | |||
| Draft as of 2024-03-04 | Computable Name: AncillaryStudiesBreast_cs | |||
Relevant information about diagnostic tests on a breast specimen which are supplementary to the main test.
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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AncillaryStudiesBreast-cs | 0..* | Base | Ancillary studies (breast) Instances of this logical model are not marked to be the target of a Reference | |
  AncillaryStudiesStatus | 1..1 | CodeableConcept | Whether or not any ancillary studies have been performed on the given specimen. | |
| AncillaryStudiesPerformedTypes | 0..* | CodeableConcept | A list of which types of ancillary studies have been performed. | |
 AncillaryStudiesPerformed | 0..* | BackboneElement | An ancillary study that has been performed on the specimen. | |
 Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| Method | 0..1 | CodeableConcept | The technique, procedure, or system used to perform the observation. | |
 Date | 0..1 | dateTime | The date and/or time that the observation was performed. | |
| PerformedBy | 0..* | BackboneElement | A person responsible for performing the observation. | |
| Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
| PersonName | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
| Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
| GivenName | 0..1 | string | The person’s forename or given name at birth | |
| FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
| NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
 age | 0..1 | string | AncillaryStudiesBreast.AncillaryStudiesPerformed.PerformedBy.PersonName.age | |
| ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
| AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
 HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
 PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
| RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
| RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
| FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
| Comments | 0..1 | string | Plain text comments about the observation. | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| ERStatus | 0..1 | BackboneElement | The ER tumour status of the breast specimen. | |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| PRStatus | 0..1 | BackboneElement | The PR tumour status of the breast specimen. | |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| HER2StatusImmunohistochemistry | 0..1 | BackboneElement | The HER2 status of the breast tumour based on an immunohistochemistry test. | |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| HER2StatusMolecular | 0..1 | BackboneElement | The HER2 status of the breast tumour based on a molecular test. | |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the molecular test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the molecular test. | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the molecular test result was inconclusive. | |
| Comments | 0..1 | string | Any additional free text comments about the ancillary studies. | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.ERStatus.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.ERStatus.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.PRStatus.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.PRStatus.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusImmunohistochemistry.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusImmunohistochemistry.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusMolecular.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AncillaryStudiesBreast-cs | 0..* | Base | Ancillary studies (breast) Instances of this logical model are not marked to be the target of a Reference | |
| AncillaryStudiesStatus | 1..1 | CodeableConcept | Whether or not any ancillary studies have been performed on the given specimen. | |
| AncillaryStudiesPerformedTypes | 0..* | CodeableConcept | A list of which types of ancillary studies have been performed. | |
| AncillaryStudiesPerformed | 0..* | BackboneElement | An ancillary study that has been performed on the specimen. | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| Method | 0..1 | CodeableConcept | The technique, procedure, or system used to perform the observation. | |
| Date | 0..1 | dateTime | The date and/or time that the observation was performed. | |
| PerformedBy | 0..* | BackboneElement | A person responsible for performing the observation. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
| PersonName | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
| GivenName | 0..1 | string | The person’s forename or given name at birth | |
| FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
| NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
| age | 0..1 | string | AncillaryStudiesBreast.AncillaryStudiesPerformed.PerformedBy.PersonName.age | |
| ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
| HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
| RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
| RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
| FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
| Comments | 0..1 | string | Plain text comments about the observation. | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| ERStatus | 0..1 | BackboneElement | The ER tumour status of the breast specimen. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| PRStatus | 0..1 | BackboneElement | The PR tumour status of the breast specimen. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| HER2StatusImmunohistochemistry | 0..1 | BackboneElement | The HER2 status of the breast tumour based on an immunohistochemistry test. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| HER2StatusMolecular | 0..1 | BackboneElement | The HER2 status of the breast tumour based on a molecular test. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the molecular test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the molecular test. | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the molecular test result was inconclusive. | |
| Comments | 0..1 | string | Any additional free text comments about the ancillary studies. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.ERStatus.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.ERStatus.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.PRStatus.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.PRStatus.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusImmunohistochemistry.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusImmunohistochemistry.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusMolecular.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AncillaryStudiesBreast-cs | 0..* | Base | Ancillary studies (breast) Instances of this logical model are not marked to be the target of a Reference | |
| AncillaryStudiesStatus | 1..1 | CodeableConcept | Whether or not any ancillary studies have been performed on the given specimen. | |
| AncillaryStudiesPerformedTypes | 0..* | CodeableConcept | A list of which types of ancillary studies have been performed. | |
| AncillaryStudiesPerformed | 0..* | BackboneElement | An ancillary study that has been performed on the specimen. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| Method | 0..1 | CodeableConcept | The technique, procedure, or system used to perform the observation. | |
| Date | 0..1 | dateTime | The date and/or time that the observation was performed. | |
| PerformedBy | 0..* | BackboneElement | A person responsible for performing the observation. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
| PersonName | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
| GivenName | 0..1 | string | The person’s forename or given name at birth | |
| FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
| NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
| age | 0..1 | string | AncillaryStudiesBreast.AncillaryStudiesPerformed.PerformedBy.PersonName.age | |
| ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
| HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
| RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
| RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
| FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
| Comments | 0..1 | string | Plain text comments about the observation. | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| ERStatus | 0..1 | BackboneElement | The ER tumour status of the breast specimen. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| PRStatus | 0..1 | BackboneElement | The PR tumour status of the breast specimen. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| HER2StatusImmunohistochemistry | 0..1 | BackboneElement | The HER2 status of the breast tumour based on an immunohistochemistry test. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| HER2StatusMolecular | 0..1 | BackboneElement | The HER2 status of the breast tumour based on a molecular test. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the molecular test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the molecular test. | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the molecular test result was inconclusive. | |
| Comments | 0..1 | string | Any additional free text comments about the ancillary studies. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.ERStatus.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.ERStatus.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.PRStatus.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.PRStatus.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusImmunohistochemistry.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusImmunohistochemistry.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusMolecular.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AncillaryStudiesBreast-cs | 0..* | Base | Ancillary studies (breast) Instances of this logical model are not marked to be the target of a Reference | |
| AncillaryStudiesStatus | 1..1 | CodeableConcept | Whether or not any ancillary studies have been performed on the given specimen. | |
| AncillaryStudiesPerformedTypes | 0..* | CodeableConcept | A list of which types of ancillary studies have been performed. | |
| AncillaryStudiesPerformed | 0..* | BackboneElement | An ancillary study that has been performed on the specimen. | |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| Method | 0..1 | CodeableConcept | The technique, procedure, or system used to perform the observation. | |
| Date | 0..1 | dateTime | The date and/or time that the observation was performed. | |
| PerformedBy | 0..* | BackboneElement | A person responsible for performing the observation. | |
| Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
| PersonName | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
| Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
| GivenName | 0..1 | string | The person’s forename or given name at birth | |
| FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
| NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
| age | 0..1 | string | AncillaryStudiesBreast.AncillaryStudiesPerformed.PerformedBy.PersonName.age | |
| ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
| AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
| HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
| PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
| RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
| RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
| FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
| Comments | 0..1 | string | Plain text comments about the observation. | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| ERStatus | 0..1 | BackboneElement | The ER tumour status of the breast specimen. | |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| PRStatus | 0..1 | BackboneElement | The PR tumour status of the breast specimen. | |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| HER2StatusImmunohistochemistry | 0..1 | BackboneElement | The HER2 status of the breast tumour based on an immunohistochemistry test. | |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| HER2StatusMolecular | 0..1 | BackboneElement | The HER2 status of the breast tumour based on a molecular test. | |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the molecular test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the molecular test. | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the molecular test result was inconclusive. | |
| Comments | 0..1 | string | Any additional free text comments about the ancillary studies. | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.ERStatus.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.ERStatus.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.PRStatus.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.PRStatus.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusImmunohistochemistry.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusImmunohistochemistry.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusMolecular.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AncillaryStudiesBreast-cs | 0..* | Base | Ancillary studies (breast) Instances of this logical model are not marked to be the target of a Reference | |
| AncillaryStudiesStatus | 1..1 | CodeableConcept | Whether or not any ancillary studies have been performed on the given specimen. | |
| AncillaryStudiesPerformedTypes | 0..* | CodeableConcept | A list of which types of ancillary studies have been performed. | |
| AncillaryStudiesPerformed | 0..* | BackboneElement | An ancillary study that has been performed on the specimen. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| Method | 0..1 | CodeableConcept | The technique, procedure, or system used to perform the observation. | |
| Date | 0..1 | dateTime | The date and/or time that the observation was performed. | |
| PerformedBy | 0..* | BackboneElement | A person responsible for performing the observation. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
| PersonName | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
| GivenName | 0..1 | string | The person’s forename or given name at birth | |
| FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
| NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
| age | 0..1 | string | AncillaryStudiesBreast.AncillaryStudiesPerformed.PerformedBy.PersonName.age | |
| ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
| HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
| RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
| RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
| FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
| Comments | 0..1 | string | Plain text comments about the observation. | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| ERStatus | 0..1 | BackboneElement | The ER tumour status of the breast specimen. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| PRStatus | 0..1 | BackboneElement | The PR tumour status of the breast specimen. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| HER2StatusImmunohistochemistry | 0..1 | BackboneElement | The HER2 status of the breast tumour based on an immunohistochemistry test. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| HER2StatusMolecular | 0..1 | BackboneElement | The HER2 status of the breast tumour based on a molecular test. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the molecular test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the molecular test. | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the molecular test result was inconclusive. | |
| Comments | 0..1 | string | Any additional free text comments about the ancillary studies. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.ERStatus.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.ERStatus.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.PRStatus.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.PRStatus.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusImmunohistochemistry.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusImmunohistochemistry.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusMolecular.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AncillaryStudiesBreast-cs | 0..* | Base | Ancillary studies (breast) Instances of this logical model are not marked to be the target of a Reference | |
| AncillaryStudiesStatus | 1..1 | CodeableConcept | Whether or not any ancillary studies have been performed on the given specimen. | |
| AncillaryStudiesPerformedTypes | 0..* | CodeableConcept | A list of which types of ancillary studies have been performed. | |
| AncillaryStudiesPerformed | 0..* | BackboneElement | An ancillary study that has been performed on the specimen. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| Method | 0..1 | CodeableConcept | The technique, procedure, or system used to perform the observation. | |
| Date | 0..1 | dateTime | The date and/or time that the observation was performed. | |
| PerformedBy | 0..* | BackboneElement | A person responsible for performing the observation. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
| PersonName | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
| GivenName | 0..1 | string | The person’s forename or given name at birth | |
| FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
| NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
| age | 0..1 | string | AncillaryStudiesBreast.AncillaryStudiesPerformed.PerformedBy.PersonName.age | |
| ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
| HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
| RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
| RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
| FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
| Comments | 0..1 | string | Plain text comments about the observation. | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| ERStatus | 0..1 | BackboneElement | The ER tumour status of the breast specimen. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| PRStatus | 0..1 | BackboneElement | The PR tumour status of the breast specimen. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| HER2StatusImmunohistochemistry | 0..1 | BackboneElement | The HER2 status of the breast tumour based on an immunohistochemistry test. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the immunohistochemistry test. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expression (preferred) | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the immunohistochemistry test result was inconclusive. | |
| HER2StatusMolecular | 0..1 | BackboneElement | The HER2 status of the breast tumour based on a molecular test. | |
| @id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Status | 1..1 | CodeableConcept | The status of the observation | |
| Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
| SpecimenId | 0..1 | Identifier | An identifier of the specimen being observed. | |
| SpecimenSentForObservation | 0..1 | boolean | Whether or not the specimen has been sent for observation. | |
| NotPerformedReason | 0..1 | CodeableConcept | The reason why the molecular test was not performed. | |
| ResultCoded | 0..1 | CodeableConcept | The coded result of the molecular test. | |
| InconclusiveReason | 0..1 | CodeableConcept | The reason why the molecular test result was inconclusive. | |
| Comments | 0..1 | string | Any additional free text comments about the ancillary studies. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.ERStatus.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.ERStatus.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-er-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.PRStatus.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.PRStatus.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-pr-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusImmunohistochemistry.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusImmunohistochemistry.ResultCoded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expressionhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-her2-expression | |
| AncillaryStudiesBreast-cs.AncillaryStudiesPerformed.HER2StatusMolecular.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base