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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

AJCC staging

Staging using the AJCC cancer staging manual that describes the prognosis of the specific disease at a given time in the patient’s cancer journey.

Additional specimen (colorectal histopathology metastectomy request)

Additional specimens provided on a colorectal metastectomy histopthology request, e.g. lymph nodes

Additional specimen (colorectal histopathology request)

Additional specimens provided on a colorectal histopthology request, e.g. lymph nodes.

Administration (pathology report)

Administration details relevant to a pathology report form.

Administration (pathology request)

Administration details relevant to a pathology request form.

Administration (radiation oncology)

Administration details relevant to a radiation oncology treatment summary form.

Ancillary studies

Relevant information about diagnostic tests on a specimen which are supplementary to the main test.

Ancillary studies (breast)

Relevant information about diagnostic tests on a breast specimen which are supplementary to the main test.

Ancillary studies (soft tissue histopathology)

Relevant information about diagnostic tests on a soft tissue specimen which are supplementary to the main test.

Ancillary studies (soft tissue)

Relevant information about diagnostic tests on a soft tissue specimen which are supplementary to the main test.

Ancillary study other

A supplementary diagnostic test on a specimen, which is described as an ‘Other ancillary study’ on the form.

Appearance of cut surface of specimen

The macroscopic appearance of the cut surface of a resection specimen. This should note areas of necrosis, haemorrhage or any variation in appearance.

Biochemistry test

Tests used to measure substances in specimens.

Body site

Details about an anatomical location or body part.

Body site summary

The main identifying details of a body site including the body structure and laterality.

Body surface area (BSA)

The measured or calculated surface area of the patient’s body.

Breast section

A section used to support compositions for breast cancers.

CM category

The clinical stage classification of distant metastasis, based on patient history, physical examination, and any imaging done before initiation of treatment.

CN category

The clinical stage classification of regional lymph nodes, based on patient history, physical examination, and any imaging done before initiation of treatment.

CT category

The clinical stage classification of the primary tumour, based on patient history, physical examination, and any imaging done before initiations of treatment.

Care plan details

The administrative details about a care plan.

Clinical Information (colorectal histopathology diagnostic request)

Clinical information about the patient, as documented on a colorectal small diagnostic request.

Clinical Information (soft tissue biopsy histopathology)

Relevant clinical information about the patient in a soft tissue biopsy histopathology composition.

Clinical TNM Staging (breast)

Clinical TNM staging for invasive carcinoma of the breast, and ductal carcinoma in situ of the breast.

Clinical TNM staging

Clinical TNM staging using the AJCC staging manual.

Clinical TNM staging (colorectal)

Clinical TNM staging for colorectal cancers, including adenocarcinomas, high-grade neuroendocrine carcinomas, and squamous carcinomas of the colon (see chapter 20 of AJCC, 8th edition).

Clinical assessment

An observation made about the patient by clinical assessment.

Clinical finding

The result of a clinical observation made on the patient, e.g. a sign, symptom, or assessment.

Clinical history

Relevant information about the patient’s previous conditions.

Clinical impression of behaviour

The suspected behaviour of the specimen, as determined by the clinician (e.g. surgeon).

Clinical impression of behaviour (breast)

The suspected behaviour of the breast specimen, as determined by the clinician (e.g. surgeon).

Clinical impression of origin

The suspected origin of the tumour, e.g. new primary, local recurrence, distant metastasis.

Clinical information (breast histopathology)

Relevant clinical information about the patient in a breast histopathology composition.

Clinical information (breast resection histopathology)

Relevant clinical information about the patient in a breast resection histopathology composition.

Clinical information (breast small diagnostic histopathology)

Relevant clinical information about the patient in a breast small diagnostic histopathology composition.

Clinical information (colorectal histopathology metastetcomy request)

Clinical information about the patient, as documented on a colorectal metastectomy histopathology form.

Clinical information (colorectal histopathology request)

Relevant clinical information about the patient, as documented on a colorectal histopathology request.

Clinical information (colorectal histopathology resection request)

Clinical information about the patient, as documented on a colorectal resection histopathology report.

Clinical information (soft tissue histopathology)

Relevant clinical information about the patient in a soft tissue histopathology composition.

Clinical margin status

The status of the tissue on the margin of a resected specimen as specified by the clinician (eg surgeon).

Clinical measurement

A clinical measurement involves the measurement of the body’s functions or properties, e.g. body temperature, pulse rate, blood pressure, weight, height.

Clinical presentation

Relevant clinical symptoms or findings that the patient presents with, e.g. breast lump.

Clinical residual tumour

The AJCC residual tumour category, as assessed by the clinician (e.g. surgeon).

Clinical staging (colorectal histopathology request)

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

Clinical status

An indicator of whether a patient is in a particular clinical state, e.g. menopausal status, pregnancy status.

Coexistent pathology

Other microscopically identifiable abnormalities relevant to the diagnosis.

Cytogenetic test

An ancillary study performed using a cytogenetic procedure.

Cytologic test

The examination of a single cell type, as often found in fluid specimens.

Dhtest1
Diagnosis (radiation oncology)

Diagnosis details relevant to a radiation oncology treatment summary form.

Differentiation

The extent to which the tumour resembles the tissue of origin.

Document details

The identifying, versioning and descriptive details of a document.

ECOG status

The performance status of a patient as defined by the Eastern Cooperative Oncology Group (ECOG).

ER tumour status

An ancillary study to test for the presence of oestrogen receptors.

Flow cytometry test

An ancillary study performed using flow cytometry.

Gastrointestinal section

A section used to support compositions for gastrointestinal cancers.

General sections

Sections that are common across multiple forms.

Genetic test

An observation about a gene, gene sequence, or panel of genes / gene sequences.

Grading (FNCLCC)

The grading of a sarcoma using the French Federation of Cancer Center’s grading system (FNCLCC = Fédération Nationale des Centres de Lutte contre le Cancer).

Grading (WHO NETs)

The grading of a neuroendocrine tumour using the WHO neuroendocrine tumour grading system.

Grading (WHO malignant high low)

The grading of a malignant neoplasm using the WHO malignant high low system.

HER2 tumour status (immunohistochemistry)

An ancillary study to test for the presence of tyrosine-protein kinase erbB-2 receptors.

HER2 tumour status (molecular)

A molecular study to test for the presence of HER2 gene amplification.

Haematology test

A laboratory test of blood formation and blood disorders.

Healthcare facility

A facility at which healthcare is provided.

Healthcare facility summary

The main identifying details of a healthcare facility.

Healthcare practitioner

A person who is directly or indirectly involved in the provision of healthcare or related services.

Healthcare practitioner summary

The main identifying details of a healthcare practitioner.

Height

The distance from the bottom of the patient’s feet to the top of their head, while they are standing.

Histologic grading

The degree of differentiation of a tumour, e.g. the extent to which a tumour resembles the normal tissue at the site.

Histologic type

A categorisation of the physical features of the cells and their surrounding tissue as seen under a microscope.

Image

An image of the patient’s tumour, specimen, or radiology.

Immunohistochemistry test

An ancillary study that is performed using immunohistochemistry.

Investigation report details

The administrative details on an investigation report.

Investigation request details

The administrative details on an investigation request, including the requester, performer, and type of investigation requested.

Ki-67 proliferation index

The percentage of cells in a tumour sample that are actively dividing.

Lymph node specimen

A lymph node sample to be used for analysis.

Lymph node status

Whether or not lymph nodes are involved in a cancer diagnosis and if so relevant information about their involvement.

Lymph node status (gastrointestinal)

Whether or not lymph nodes are involved in a gastrointestinal cancer diagnosis and if so relevant information about their involvement.

Lymph nodes (breast histopathology)

Information about any lymph node specimens taken in addition to the main breast specimen.

Lymphovascular invasion

Whether or not lymphovascular invasion of the cancer is present.

Macroscopic (soft tissue biopsy histopathology)

Observations on a specimen that are visible to the naked eye, as documented on a soft tissue biopsy histopathology report.

Macroscopic (soft tissue histopathology)

Observations on a specimen that are visible to the naked eye, as documented on a soft tissue histopathology report.

Macroscopic finding

An observation on a specimen that is visible to the naked eye.

Macroscopic findings (colorectal diagnostic histopathology report)

Observations on a specimen that are visible to the naked eye, as documented on a colorectal diagnostic histopathology report.

Macroscopic findings (colorectal resection histopathology report)

Observations on a specimen that are visible to the naked eye, as documented on a colorectal resection histopathology report.

Margin details

Details about a particular margin on a resected specimen.

Margin status

The status of the tissue on the margin of a resected specimen.

Medical condition

A medical condition that is known to be present in the patient.

Menopausal status

An indication of whether the patient is pre or post menopausal.

Microscopic (soft tissue biopsy histopathology)

Observations on a specimen that are only visible under a microscope, as documented on a soft tissue biopsy histopathology report.

Microscopic (soft tissue histopathology)

Observations on a specimen that are only visible under a microscope, as documented on a soft tissue histopathology report.

Microscopic finding

The examination of tissues and/or cells under a microscope to diagnose and study diseases of the tissues.

Microscopic findings (Colorectal histopathology report)

Observations on a specimen that are only visible under a microscope, as documented on a colorectal histopathology report.

Microscopic findings (colorectal histopathology diagnostic report)

Observations on a specimen that are only visible under a microscope, as documented on a colorectal diagnostic histopathology report.

Microscopic findings (colorectal histopathology endoscopic resection report)

Observations on a specimen that are only visible under a microscope, as documented on a colorectal endoscopic resection histopathology report.

Microscopic findings (colorectal histopathology metastectomy resection report)

Observations on a specimen that are only visible under a microscope, as documented on a colorectal metastectomy histopathology report.

Microscopic findings (colorectal histopathology operative resection report)

Observations on a specimen that are only visible under a microscope, as documented on a colorectal operative resection histopathology report.

Microscopic findings (colorectal histopathology resection report)

Observations on a specimen that are only visible under a microscope, as documented on a colorectal resection histopathology report.

Mitotic count

The number of mitotic figures per high-power field (HPF) found in the most mitotically active part of the tumour.

Molecular test

An ancillary study performed using a molecular testing procedure.

NZ address

An address or location using NZ CIQ address profile format.

NZ contact details

The electronic contact details required eg: for person or organisation

NZ person name

The name of a person, e.g. patient or healthcare provider, structured following the HISO naming standards.

Necrosis

The percentage of tumour volume with necrosis.

Neoadjuvant therapy response

An assessment of the response to neoadjuvant therapy.

Neoadjuvant therapy response (soft tissue)

An assessment of the response to neoadjuvant therapy for a soft tissue tumour.

Neoadjuvant therapy summary

A summary of the patient’s neoadjuvant treatment status and details.

Observation

A measurement or assertion made about a patient, e.g. a clinical assessment, imaging results, or laboratory finding.

PM category

The pathological stage classification of distant metastasis, based on diagnostic work-up from clinical staging combined with operative findings and pathological review of specimens.

PN category

The pathological stage classification of regional lymph nodes, based on diagnostic work-up from clinical staging combined with operative findings and pathological review of specimens.

PR tumour status

An ancillary study to test for the presence of progesterone receptors.

PT category

The pathological stage classification of the primary tumour, based on diagnostic work-up from clinical staging combined with operative findings and pathological review of specimens.

Pathological TNM Staging (breast)

Pathological TNM staging for invasive carcinoma of the breast, and ductal carcinoma in situ of the breast.

Pathological TNM staging

Pathological TNM staging using the AJCC staging manual.

Pathological TNM staging (soft tissue)

Pathological TNM staging for soft tissue sarcomas and related cancers.

Pathological staging (soft tissue histopathology)

Pathological TNM staging using a AJCC staging manual for a soft tissue tumour.

Pathology report details

The administrative details on a pathology report.

Pathology request details

The administrative details on a pathology test request, including tissue consent details.

Patient

Identifying and demographic details about the patient.

Patient details

A short summary of the main identifying details for a patient, as seen on a CanShare form.

Patient details (pathology)

A short summary of the main identifying details for a patient, as seen on a pathology form.

Perineural invasion

Whether or not perineural invasion of the cancer is present.

Previous biopsy result (breast histopathology)

Relevant details about previous biopsy results for the breast tumour.

Previous medical condition

A relevant medical condition that the patient had previously.

Previous sampling diagnosis

A relevant histological type of any previous specimen.

Primary cancer diagnosis

A primary cancer condition that is diagnosed in the patient (either clinically or pathologically). For solid cancers, this is the original or first neoplasm in the body. For haematologic cancers, this is the original cancer type in the body. This also includes cancers of uncertain origin or behaviour.

Procedure

An action that is or was performed on or for a patient, e.g. surgical procedure, biopsy procedure.

Procedure (colorectal histopathology diagnostic request)

Relevant details about the procedure during which the small diagnostic specimen was collected, as documented on a colorectal small diagnostic histopathology request.

Procedure (colorectal histopathology endoscopic resection request)

Relevant details about the procedure during which the endoscopic resection specimen was collected, as documented on a colorectal histopathology endoscopic resection request.

Procedure (colorectal histopathology metastectomy request)

Relevant details about the metastectomy procedure during which the specimen was collected, as documented on a colorectal histopathology metastectomy request.

Procedure (colorectal histopathology operative resection request)

Relevant details about the procedure during which the operative resection specimen was collected, as documented on a colorectal histopathology operative resection request.

Procedure (colorectal histopathology request)

Relevant details about the procedure during which the specimen was collected, as documented on a colorectal histopathology request.

Procedure (colorectal histopathology resection request)

Relevant details about the procedure during which the resection specimen was collected, as documented on a colorectal histopathology resection request.

Prognostic score

A prediction of the likely disease outcome based on a selected set of prognostic factors.

Radiation oncology section

A section used to support compositions for radiation oncology.

Radiation therapy course

A single course of radiation therapy.

Radiology

The radiologic imaging used to examine parts of the body to aid diagnosis and guide treatment plans.

Radiology (breast)

The radiologic imaging used to examine the breasts to aid diagnosis and guide treatment plans.

Referral pathway

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

Referral pathway (colorectal diagnostic)

Referral pathway details for colorectal diagnostic services.

Referral pathway (colorectal resection)

Referral pathway details for a colorectal resection.

Referral pathway (colorectal screening)

Referral pathway details for colorectal screening services.

Referral pathway (colorectal surveillance)

Referral pathway details for colorectal surveillance services.

Referral pathway (colorectal)

Referral pathway details for colorectal services.

Report details

The administrative details on a clinical report.

Request details

The administrative details on a service request, including the requester, requested service provider and date of request.

SACT regimen

A single regimen therapy for systemic anti-cancer therapy.

Section

A datagroup used to bundle multiple datagroups together for organising into a section of a composition.

Serum creatinine

A measurement of the concentration of creatinine in the blood, used to determine renal function.

Soft tissue (biopsy) - Histopathology report

A histopathology report form for soft tissue tumours from a biopsy specimen.

Soft tissue (biopsy) - Histopathology request

A histopathology request form for soft tissue tumours from a biopsy specimen.

Soft tissue and bone section

A section used to support compositions for soft tissue and/or bone cancers.

Specimen

A sample to be used for analysis.

Specimen (breast histopathology)

Relevant details about the specimen in a breast histopathology composition.

Specimen (breast resection histopathology)

Relevant specimen information in a breast resection histopathology composition.

Specimen (breast small diagnostic histopathology)

Relevant specimen information in a breast small diagnostic histopathology composition.

Specimen (colorectal histopathology request)

Relevant details about the specimen in a colorectal histopathology request.

Specimen (colorectal screening histopathology)

Relevant details about the specimen in a colorectal screening histpathology request.

Specimen (colorectal surveillance/diagnostic histopathology request)

Relevant details about the specimen in a colorectal surveillance or diagnostic histopathology request.

Specimen (soft tissue biopsy histopathology)

Relevant details about the biopsy specimen in a soft tissue histopathology composition.

Specimen (soft tissue histopathology)

Relevant details about the specimen in a soft tissue histopathology composition.

Specimen (soft tissue resection histopathology)

Relevant details about the resection specimen in a soft tissue histopathology composition.

Specimen blocking data

Details about the blocking preparation done for each specimen.

Specimen container

An individual container (e.g. a specific tube) in which the specimen is placed.

Specimen dimensions

The size of the specimen measured in one or more dimensions.

Specimen observation
Specimen orientation markers

Orientation markers of a tissue sample (used for excision/resection specimens).

Specimen reference

A reference to a specimen collected from a patient.

Specimen tumour (colorectal histopathology request)

Relevant details about the patient’s tumour on a specimen, as documented on a colorectal histopathology request.

Spread

Details about how far and where the cancer has spread.

Spread into adjacent organs

Details about any spread into adjacent organs of the primary tumour.

Spread into regional locations

Details about any spread into regional locations of the primary tumour.

Spread to distant metastasis

Details about any distant metastasis of the primary tumour.

Staging

Staging information that describes the prognosis of the specific disease at a given time in the patient’s cancer journey.

Staging (radiation oncology)

TNM staging using the AJCC staging manual, which is relevant to a radiation oncology treatment summary form.

Surgical procedure

A medical procedure performed by surgeon.

TNM category

An observation of the T, N, or M category stage of a cancer.

Test panel

A predetermined group of laboratory tests used in the diagnosis and treatment of disease.

Therapy
Therapy induced tissue changes

Any histologic changes (e.g. shrinkage of tumour cells) seen following therapy.

Treatment course (radiation oncology)

Details about the treatment course(s) relevant to a radiation oncology treatment summary form.

Treatment request details

The administrative details on a treatment request.

Tumour

An abnormal change and/or damage in a body structure or tissue.

Tumour (colorectal histopathology metastectomy request)

Details about the patient’s tumour, as documented on a colorectal metastectomy histopathology request.

Tumour (colorectal histopathology report)

Relevant details about the patient’s tumour, as documented on a colorectal histopathology report.

Tumour (colorectal histopathology resection request)

Details about the patient’s tumour, as documented on a colorectal resection histopathology request.

Tumour (soft tissue biopsy histopathology)

Relevant details about the tumour in a soft tissue biopsy histopathology composition.

Tumour (soft tissue histopathology)

Relevant details about the tumour in a soft tissue histopathology composition.

Tumour budding

A prognostic biomarker that scores the number of tumour buds (i.e. isolated single cancer cells or clusters of up to 4 cancer cells located at the invasive tumour front).

Tumour depth (tissue plane)

The deepest layer in which the tumour is present.

Tumour dimensions

The size of the tumour measured in one or more dimensions.

Tumour group

Information about one or more tumours found in a single organ.

Tumour observation

The result of an observation on a tumour or lesion.

Tumour reference

A reference to a lesion/tumour for a patient.

Tumour tissue invasion

Information about the tumour’s direct penetration into surrounding tissue.

Tumours (breast histopathology)

Relevant details about the tumours in a breast histopathology composition.

Viable tumour

The percentage of residual viable tumour after neoadjuvant therpay.

Weight

A measurement of the patient’s weight.

childOfAncillary
my ancillary
patient general copy
section copy
sectionc
sectiond
sectione
sectionf
sectiong
sectionh
sectioni
sectionj

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Body surface area (BSA)

The measured or calculated surface area of the patient’s body.

Colorectal (diagnostic) - Histopathology request

A histopathology request form for colorectal small diagnostic symptomatic specimens.

Colorectal (metastectomy) - Histopathology request

A histopathology request form for colorectal metastectomy specimens.

Height

The distance from the bottom of the patient’s feet to the top of their head, while they are standing.

New Composition
Observation

A measurement or assertion made about a patient, e.g. a clinical assessment, imaging results, or laboratory finding.

Patient

Identifying and demographic details about the patient.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Ethnicity

A classification of the ethnicity of an individual person as self-identified by the person

NameProtectionFlag

This indicator denotes that the person’s name information is to be held ‘in confidence’

Sex

A classification of the person’s sex characteristics such as chromosomes, hormones and reproductive organs (Stats NZ Statistical standard for gender, sex, and variations of sex characteristics).

Suburb

The name of the suburb or district within a city/town.

age