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
Official URL: http://example.org/StructureDefinition/HistopathologyRequestSoftTissueBiopsy | Version: 0.1.0 | |||
Draft as of 2024-03-04 | Computable Name: HistopathologyRequestSoftTissueBiopsy | |||
Other Identifiers: http://canshare.co.nz/ns/lmComp#HistopathologyRequestSoftTissueBiopsy |
A histopathology request form for soft tissue tumours from a biopsy specimen.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HistopathologyRequestSoftTissueBiopsy | 0..* | Base | Soft tissue (biopsy) - Histopathology request Instances of this logical model are not marked to be the target of a Reference | |
PatientDetails | 1..1 | BackboneElement | Patient details | |
Patient | 0..1 | BackboneElement | A short summary of the main identifying details for a patient.. | |
Nhi | 1..1 | Identifier | A unique identifier assigned to a person by the NHI system. | |
NZName | 1..1 | BackboneElement | A person’s name details | |
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 | |
OtherGivenName | 0..* | string | The person’s other given names or middle name and initials, but not the family name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameSuffix | 0..* | string | The suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership | |
PreferredNameIndicator | 0..1 | CodeableConcept | An indicator used to denote that a particular person name is the person’s preferred name | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | SectionPathologyPatient.Patient.NZName.age | |
NameInfoSource | 0..1 | CodeableConcept | A code indicating the name source | |
NameEffectivePeriod | 0..1 | Period | The date(s) the name is effective from and/or to | |
BirthdatePlace | 0..1 | BackboneElement | A person’s birth details | |
DOB | 0..1 | date | The date on which the person was born | |
DOBInfoSource | 0..1 | CodeableConcept | A code indicating the origin of date of birth information | |
PlaceBirth | 0..1 | string | The town, suburb, city etc where the person was born | |
CountryBirthCode | 0..1 | CodeableConcept | Country where the person was born | |
CountryBirthInfoSource | 0..1 | CodeableConcept | A code indicating the source of information supporting the code for country of birth | |
Age | 0..1 | integer | The age of the patient at the time the data was recorded. | |
Gender | 0..1 | code | A classification of the person's gender as self-identified by the person | |
Sex | 0..1 | CodeableConcept | 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). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred) | |
Ethnicity | 1..* | CodeableConcept | A classification of the ethnicity of an individual person as self-identified by the person Binding: https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity (preferred) | |
Address | 0..* | BackboneElement | The person's current address or location details if known (in NZ CIQ address profile format. | |
Type | 0..1 | CodeableConcept | The type of address, e.g. residential (physical), mailing (postal) | |
BuildingName | 0..1 | string | The name of the building or institution. | |
StreetAddress1 | 0..1 | string | The floor, unit and/or street address details. | |
StreetAddress2 | 0..1 | string | Other geographic information related to the address | |
Suburb | 0..1 | string | The name of the suburb or district within a city/town. | |
City | 0..1 | CodeableConcept | SectionPathologyPatient.Patient.Address.City | |
Postcode | 0..1 | string | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. | |
CountryCode | 0..1 | code | The two character ISO code that forms part of the address. | |
AddressProtectedFlag | 0..1 | boolean | This indicator denotes that the person’s address information is to be held ‘in confidence’ | |
PermanentAddressFlag | 0..1 | CodeableConcept | An indicator used to denote an address is a permanent address | |
DateAddressPeriod | 0..1 | Period | Date(s) that an address is effective from and/or to | |
DomicileCode | 0..1 | CodeableConcept | New Zealand health domicile code representing a person’s usual residential address | |
PrimaryAddressFlag | 0..1 | CodeableConcept | An indicator used to denote that the address is the primary address for the person | |
Title | 0..1 | string | SectionPathologyPatient.Patient.Title | |
Administration | 1..1 | BackboneElement | Administration | |
Administration | 1..1 | BackboneElement | Administration details as seen on a pathology request form. | |
DocumentId | 0..* | Identifier | A version-independent identifier for the document | |
LocalDocumentIdentifier | 0..1 | Identifier | A local identifier of the document that is unique only at the facility at which the document is created. | |
Version | 0..1 | string | An explicitly assigned identifier of a variation of the content in the document. | |
Author | 0..1 | BackboneElement | The healthcare practitioner who authored of the document. | |
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 | SectionPathologyRequestAdministration.Administration.Author.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. | |
AuthoredDate | 0..1 | dateTime | The date on which this version of the document was authored. | |
Status | 1..1 | code | The status of the document (as defined by HL7 FHIR) | |
Category | 0..* | CodeableConcept | The high-level kind of the document, e.g. pathology request, pathology report, treatment plan. | |
Type | 1..1 | CodeableConcept | The specific type of document, e.g. breast pathology request for biopsy specimens | |
Encounter | 0..1 | Identifier | The patient encounter associated with this document. | |
Requester | 0..1 | BackboneElement | The healthcare practitioner who is requesting the service. | |
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 | SectionPathologyRequestAdministration.Administration.Requester.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. | |
Performer | 0..* | BackboneElement | The healthcare practitioner and/or facility from whom the service is being requested. | |
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 | SectionPathologyRequestAdministration.Administration.Performer.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. | |
CopyTo | 0..* | BackboneElement | Any healthcare practitioners to whom a copy of the report should be sent (in addition to the requester). | |
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 | SectionPathologyRequestAdministration.Administration.CopyTo.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. | |
Intent | 1..1 | CodeableConcept | The main purpose of the service requested, e.g. diagnostic, treatment | |
InvestigationCategory | 0..1 | CodeableConcept | The high-level kind of investigation requested, e.g. radiology, pathology, surgery. | |
InvestigationType | 1..1 | CodeableConcept | The type of investigation requested, e.g. ultrasound, histology, cytology, colonoscopy. | |
TissueBankingConsent | 0..1 | CodeableConcept | Whether or not the patient has consented to have their tissue stored for future research (either specified or unspecified). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-details (preferred) | |
TissueReturnRequest | 0..1 | CodeableConcept | Whether or not the patient has requested to have their tissue returned to them, e.g. return, don't return, partial return. | |
ClinicalInformation | 1..1 | BackboneElement | Clinical information | |
ClinicalPresentation | 0..1 | BackboneElement | Relevant clinical symptoms or findings that the patient presents with, e.g.lump. | |
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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
testbool | 0..1 | boolean | SoftTissueBiopsyHistoClinicalInformation.ClinicalPresentation.testbool | |
Spread | 0..1 | BackboneElement | Details about how far and where the cancer has spread. | |
AdjacentOrganInvolvement | 0..1 | BackboneElement | Details about any adjacent organ involvement of the primary tumour. | |
AdjacentOrganInvolvement | 0..1 | CodeableConcept | Whether or not the tumour has invaded into adjacent organs. | |
AdjacentOrganInvaded | 0..* | CodeableConcept | Which adjacent organs the tumour has invaded. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography (preferred) | |
Comments | 0..1 | string | Free text comments that describe whether or not the tumour has invaded adjacent organs, and if so which ones. | |
RegionalSpread | 0..1 | BackboneElement | Details about any regional spread of the primary tumour. | |
RegionalSpreadLocation | 0..1 | CodeableConcept | The regional location(s) in the body to which the primary cancer has spread. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography (preferred) | |
Comments | 0..1 | string | Free text comments about the regional spread of the tumour. | |
DistantMetastasis | 0..1 | BackboneElement | Details about any distant metastasis of the primary tumour. | |
Status | 0..1 | CodeableConcept | Whether or not the tumour has spread to a distant organ. | |
DistantMetastasisLocation | 0..* | CodeableConcept | The distant location(s) in the body to which the primary cancer has spread. | |
Comments | 0..1 | string | Free text comments about any distant metastasis of the tumour. | |
PreviousRelevantPathology | 0..1 | BackboneElement | Any pathology results that are relevant to this histopathology request. | |
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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Radiology | 0..1 | BackboneElement | The radiologic imaging used to examine parts of the body to aid diagnosis and guide treatment plans. | |
Comments | 0..1 | string | Free text comments about the radiology imaging procedure and/or their results. | |
ClinicalFinding | 0..1 | BackboneElement | Any additional clinical information that is relevant to the histopathology request. | |
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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Tumour | 1..* | BackboneElement | Tumour | |
Tumour | 0..1 | BackboneElement | An abnormal change and/or damage in a body structure or tissue. | |
TumourId | 0..1 | string | The number or identifier used to reference the given lesion/tumour. | |
TumourSite | 0..1 | BackboneElement | The body location of the lesion/tumour. | |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
newElement | 0..1 | string | SoftTissueBiopsyHistoTumour.Tumour.TumourSite.newElement | |
Comments | 0..1 | string | Free text comments about the lesion/tumour. | |
TumourDepth | 0..1 | BackboneElement | The deepest layer in which the tumour is present. | |
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) | |
TumourIdentifier | 0..1 | Identifier | An identifier for the tumour about which the observation is made. | |
TumourDepthStatus | 1..1 | CodeableConcept | Whether or not the tumour depth (tumour plane) is able to be assessed. | |
TumourDepth | 0..* | CodeableConcept | The deepest layer in which the tumour is present. | |
TumourDimensions | 0..1 | BackboneElement | The size of the tumour measured in one or more dimension. | |
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) | |
TumourIdentifier | 0..1 | Identifier | An identifier for the tumour about which the observation is made. | |
TumourDimensionsStatus | 0..1 | CodeableConcept | Whether or not the tumour dimensions have been measured. | |
MaximumTumourDimension | 0..1 | Quantity | A measurement of the largest dimension of the tumour. | |
Dimension | 0..* | BackboneElement | A measurement of one of the dimensions of the tumour. | |
Type | 1..1 | CodeableConcept | The type of dimension in which this measurement was taken, e.g. length, width, depth. | |
Size | 1..1 | Quantity | The size of the lesion in the given dimension. | |
Specimen | 1..* | BackboneElement | Specimen | |
Specimen | 0..1 | BackboneElement | A sample to be used for analysis. | |
Id | 0..* | Identifier | An identifier for the specimen, e.g. a barcode. | |
TumourIdentifier | 0..* | string | The number or identifier used to reference the given lesion/tumour. | |
Category | 0..1 | CodeableConcept | The category of specimen, e.g. biopsy specimen | |
Type | 0..1 | CodeableConcept | The type of specimen, e.g. core biopsy specimen, lymph node excision specimen. | |
Qualifier | 0..1 | CodeableConcept | A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified. | |
Collection | 0..1 | BackboneElement | Details about the collection of the specimen. | |
CollectionDate | 0..1 | dateTime | The date and/or time that the sample/specimen was collected. | |
BodySite | 0..1 | BackboneElement | The site from which the sample/specimen was collected. | |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
newElement | 0..1 | string | SoftTissueBiopsyHistoSpecimen.Specimen.Collection.BodySite.newElement | |
Technique | 0..* | CodeableConcept | The technique used to collect the specimen, e.g. Random specimen collection. | |
ContainerQuantity | 0..1 | Quantity | A count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection. | |
Comments | 0..1 | string | Free text comments about the specimen. | |
SpecimenContainer | 0..* | BackboneElement | An individual container (e.g. a specific tube) in which the specimen is placed. | |
ContainerId | 0..1 | Identifier | An identifier for the individual specimen container. | |
SpecimenId | 0..1 | Identifier | An identifier for the specimen in the container. | |
SpecimenQualifier | 0..1 | CodeableConcept | A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified. | |
PreparationTechnique | 0..* | CodeableConcept | SoftTissueBiopsyHistoSpecimen.SpecimenContainer.PreparationTechnique | |
MediumStatus | 0..1 | CodeableConcept | Whether or not the specimen is fresh or in a medium. | |
MediumType | 0..1 | CodeableConcept | The type of medium used for the specimen in the container. | |
Quantity | 0..1 | Quantity | The quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container. | |
ClinicalImpression | 0..1 | BackboneElement | The suspected behaviour of the specimen, e.g. benign, in situ, malignant. | |
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. | |
Value | 1..1 | CodeableConcept | The suspected behaviour of the specimen, e.g. benign, in situ, malignant. | |
AncillaryStudies | 0..* | BackboneElement | A diagnostic test on a specimen, which is supplementary to the main 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 ancillary study. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HistopathologyRequestSoftTissueBiopsy.PatientDetails.Patient.Sex | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sexhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex | |
HistopathologyRequestSoftTissueBiopsy.PatientDetails.Patient.Ethnicity | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicityhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |
HistopathologyRequestSoftTissueBiopsy.Administration.Administration.TissueBankingConsent | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-detailshttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-details | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.ClinicalPresentation.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.Spread.AdjacentOrganInvolvement.AdjacentOrganInvaded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.Spread.RegionalSpread.RegionalSpreadLocation | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.PreviousRelevantPathology.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.ClinicalFinding.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Tumour.Tumour.TumourSite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
HistopathologyRequestSoftTissueBiopsy.Tumour.TumourDepth.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Tumour.TumourDimensions.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Specimen.Specimen.Collection.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
HistopathologyRequestSoftTissueBiopsy.Specimen.ClinicalImpression.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Specimen.AncillaryStudies.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 |
---|---|---|---|---|
HistopathologyRequestSoftTissueBiopsy | 0..* | Base | Soft tissue (biopsy) - Histopathology request Instances of this logical model are not marked to be the target of a Reference | |
PatientDetails | 1..1 | BackboneElement | Patient details | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Patient | 0..1 | BackboneElement | A short summary of the main identifying details for a patient.. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Nhi | 1..1 | Identifier | A unique identifier assigned to a person by the NHI system. | |
NZName | 1..1 | BackboneElement | A person’s name details | |
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 | |
OtherGivenName | 0..* | string | The person’s other given names or middle name and initials, but not the family name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameSuffix | 0..* | string | The suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership | |
PreferredNameIndicator | 0..1 | CodeableConcept | An indicator used to denote that a particular person name is the person’s preferred name | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | SectionPathologyPatient.Patient.NZName.age | |
NameInfoSource | 0..1 | CodeableConcept | A code indicating the name source | |
NameEffectivePeriod | 0..1 | Period | The date(s) the name is effective from and/or to | |
BirthdatePlace | 0..1 | BackboneElement | A person’s birth details | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
DOB | 0..1 | date | The date on which the person was born | |
DOBInfoSource | 0..1 | CodeableConcept | A code indicating the origin of date of birth information | |
PlaceBirth | 0..1 | string | The town, suburb, city etc where the person was born | |
CountryBirthCode | 0..1 | CodeableConcept | Country where the person was born | |
CountryBirthInfoSource | 0..1 | CodeableConcept | A code indicating the source of information supporting the code for country of birth | |
Age | 0..1 | integer | The age of the patient at the time the data was recorded. | |
Gender | 0..1 | code | A classification of the person's gender as self-identified by the person | |
Sex | 0..1 | CodeableConcept | 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). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred) | |
Ethnicity | 1..* | CodeableConcept | A classification of the ethnicity of an individual person as self-identified by the person Binding: https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity (preferred) | |
Address | 0..* | BackboneElement | The person's current address or location details if known (in NZ CIQ address profile format. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Type | 0..1 | CodeableConcept | The type of address, e.g. residential (physical), mailing (postal) | |
BuildingName | 0..1 | string | The name of the building or institution. | |
StreetAddress1 | 0..1 | string | The floor, unit and/or street address details. | |
StreetAddress2 | 0..1 | string | Other geographic information related to the address | |
Suburb | 0..1 | string | The name of the suburb or district within a city/town. | |
City | 0..1 | CodeableConcept | SectionPathologyPatient.Patient.Address.City | |
Postcode | 0..1 | string | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. | |
CountryCode | 0..1 | code | The two character ISO code that forms part of the address. | |
AddressProtectedFlag | 0..1 | boolean | This indicator denotes that the person’s address information is to be held ‘in confidence’ | |
PermanentAddressFlag | 0..1 | CodeableConcept | An indicator used to denote an address is a permanent address | |
DateAddressPeriod | 0..1 | Period | Date(s) that an address is effective from and/or to | |
DomicileCode | 0..1 | CodeableConcept | New Zealand health domicile code representing a person’s usual residential address | |
PrimaryAddressFlag | 0..1 | CodeableConcept | An indicator used to denote that the address is the primary address for the person | |
Title | 0..1 | string | SectionPathologyPatient.Patient.Title | |
Administration | 1..1 | BackboneElement | Administration | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Administration | 1..1 | BackboneElement | Administration details as seen on a pathology request form. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
DocumentId | 0..* | Identifier | A version-independent identifier for the document | |
LocalDocumentIdentifier | 0..1 | Identifier | A local identifier of the document that is unique only at the facility at which the document is created. | |
Version | 0..1 | string | An explicitly assigned identifier of a variation of the content in the document. | |
Author | 0..1 | BackboneElement | The healthcare practitioner who authored of the document. | |
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 | SectionPathologyRequestAdministration.Administration.Author.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. | |
AuthoredDate | 0..1 | dateTime | The date on which this version of the document was authored. | |
Status | 1..1 | code | The status of the document (as defined by HL7 FHIR) | |
Category | 0..* | CodeableConcept | The high-level kind of the document, e.g. pathology request, pathology report, treatment plan. | |
Type | 1..1 | CodeableConcept | The specific type of document, e.g. breast pathology request for biopsy specimens | |
Encounter | 0..1 | Identifier | The patient encounter associated with this document. | |
Requester | 0..1 | BackboneElement | The healthcare practitioner who is requesting the service. | |
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 | SectionPathologyRequestAdministration.Administration.Requester.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. | |
Performer | 0..* | BackboneElement | The healthcare practitioner and/or facility from whom the service is being requested. | |
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 | SectionPathologyRequestAdministration.Administration.Performer.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. | |
CopyTo | 0..* | BackboneElement | Any healthcare practitioners to whom a copy of the report should be sent (in addition to the requester). | |
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 | SectionPathologyRequestAdministration.Administration.CopyTo.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. | |
Intent | 1..1 | CodeableConcept | The main purpose of the service requested, e.g. diagnostic, treatment | |
InvestigationCategory | 0..1 | CodeableConcept | The high-level kind of investigation requested, e.g. radiology, pathology, surgery. | |
InvestigationType | 1..1 | CodeableConcept | The type of investigation requested, e.g. ultrasound, histology, cytology, colonoscopy. | |
TissueBankingConsent | 0..1 | CodeableConcept | Whether or not the patient has consented to have their tissue stored for future research (either specified or unspecified). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-details (preferred) | |
TissueReturnRequest | 0..1 | CodeableConcept | Whether or not the patient has requested to have their tissue returned to them, e.g. return, don't return, partial return. | |
ClinicalInformation | 1..1 | BackboneElement | Clinical information | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
ClinicalPresentation | 0..1 | BackboneElement | Relevant clinical symptoms or findings that the patient presents with, e.g.lump. | |
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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
testbool | 0..1 | boolean | SoftTissueBiopsyHistoClinicalInformation.ClinicalPresentation.testbool | |
Spread | 0..1 | BackboneElement | Details about how far and where the cancer has spread. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
AdjacentOrganInvolvement | 0..1 | BackboneElement | Details about any adjacent organ involvement of the primary tumour. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
AdjacentOrganInvolvement | 0..1 | CodeableConcept | Whether or not the tumour has invaded into adjacent organs. | |
AdjacentOrganInvaded | 0..* | CodeableConcept | Which adjacent organs the tumour has invaded. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography (preferred) | |
Comments | 0..1 | string | Free text comments that describe whether or not the tumour has invaded adjacent organs, and if so which ones. | |
RegionalSpread | 0..1 | BackboneElement | Details about any regional spread of the primary tumour. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
RegionalSpreadLocation | 0..1 | CodeableConcept | The regional location(s) in the body to which the primary cancer has spread. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography (preferred) | |
Comments | 0..1 | string | Free text comments about the regional spread of the tumour. | |
DistantMetastasis | 0..1 | BackboneElement | Details about any distant metastasis of the primary tumour. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Status | 0..1 | CodeableConcept | Whether or not the tumour has spread to a distant organ. | |
DistantMetastasisLocation | 0..* | CodeableConcept | The distant location(s) in the body to which the primary cancer has spread. | |
Comments | 0..1 | string | Free text comments about any distant metastasis of the tumour. | |
PreviousRelevantPathology | 0..1 | BackboneElement | Any pathology results that are relevant to this histopathology request. | |
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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Radiology | 0..1 | BackboneElement | The radiologic imaging used to examine parts of the body to aid diagnosis and guide treatment plans. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Comments | 0..1 | string | Free text comments about the radiology imaging procedure and/or their results. | |
ClinicalFinding | 0..1 | BackboneElement | Any additional clinical information that is relevant to the histopathology request. | |
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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Tumour | 1..* | BackboneElement | Tumour | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Tumour | 0..1 | BackboneElement | An abnormal change and/or damage in a body structure or tissue. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
TumourId | 0..1 | string | The number or identifier used to reference the given lesion/tumour. | |
TumourSite | 0..1 | BackboneElement | The body location of the lesion/tumour. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
newElement | 0..1 | string | SoftTissueBiopsyHistoTumour.Tumour.TumourSite.newElement | |
Comments | 0..1 | string | Free text comments about the lesion/tumour. | |
TumourDepth | 0..1 | BackboneElement | The deepest layer in which the tumour is present. | |
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) | |
TumourIdentifier | 0..1 | Identifier | An identifier for the tumour about which the observation is made. | |
TumourDepthStatus | 1..1 | CodeableConcept | Whether or not the tumour depth (tumour plane) is able to be assessed. | |
TumourDepth | 0..* | CodeableConcept | The deepest layer in which the tumour is present. | |
TumourDimensions | 0..1 | BackboneElement | The size of the tumour measured in one or more dimension. | |
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) | |
TumourIdentifier | 0..1 | Identifier | An identifier for the tumour about which the observation is made. | |
TumourDimensionsStatus | 0..1 | CodeableConcept | Whether or not the tumour dimensions have been measured. | |
MaximumTumourDimension | 0..1 | Quantity | A measurement of the largest dimension of the tumour. | |
Dimension | 0..* | BackboneElement | A measurement of one of the dimensions of the tumour. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Type | 1..1 | CodeableConcept | The type of dimension in which this measurement was taken, e.g. length, width, depth. | |
Size | 1..1 | Quantity | The size of the lesion in the given dimension. | |
Specimen | 1..* | BackboneElement | Specimen | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Specimen | 0..1 | BackboneElement | A sample to be used for analysis. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Id | 0..* | Identifier | An identifier for the specimen, e.g. a barcode. | |
TumourIdentifier | 0..* | string | The number or identifier used to reference the given lesion/tumour. | |
Category | 0..1 | CodeableConcept | The category of specimen, e.g. biopsy specimen | |
Type | 0..1 | CodeableConcept | The type of specimen, e.g. core biopsy specimen, lymph node excision specimen. | |
Qualifier | 0..1 | CodeableConcept | A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified. | |
Collection | 0..1 | BackboneElement | Details about the collection of the specimen. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
CollectionDate | 0..1 | dateTime | The date and/or time that the sample/specimen was collected. | |
BodySite | 0..1 | BackboneElement | The site from which the sample/specimen was collected. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
newElement | 0..1 | string | SoftTissueBiopsyHistoSpecimen.Specimen.Collection.BodySite.newElement | |
Technique | 0..* | CodeableConcept | The technique used to collect the specimen, e.g. Random specimen collection. | |
ContainerQuantity | 0..1 | Quantity | A count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection. | |
Comments | 0..1 | string | Free text comments about the specimen. | |
SpecimenContainer | 0..* | BackboneElement | An individual container (e.g. a specific tube) in which the specimen is placed. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
ContainerId | 0..1 | Identifier | An identifier for the individual specimen container. | |
SpecimenId | 0..1 | Identifier | An identifier for the specimen in the container. | |
SpecimenQualifier | 0..1 | CodeableConcept | A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified. | |
PreparationTechnique | 0..* | CodeableConcept | SoftTissueBiopsyHistoSpecimen.SpecimenContainer.PreparationTechnique | |
MediumStatus | 0..1 | CodeableConcept | Whether or not the specimen is fresh or in a medium. | |
MediumType | 0..1 | CodeableConcept | The type of medium used for the specimen in the container. | |
Quantity | 0..1 | Quantity | The quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container. | |
ClinicalImpression | 0..1 | BackboneElement | The suspected behaviour of the specimen, e.g. benign, in situ, malignant. | |
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. | |
Value | 1..1 | CodeableConcept | The suspected behaviour of the specimen, e.g. benign, in situ, malignant. | |
AncillaryStudies | 0..* | BackboneElement | A diagnostic test on a specimen, which is supplementary to the main 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 ancillary study. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HistopathologyRequestSoftTissueBiopsy.PatientDetails.Patient.Sex | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sexhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex | |
HistopathologyRequestSoftTissueBiopsy.PatientDetails.Patient.Ethnicity | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicityhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |
HistopathologyRequestSoftTissueBiopsy.Administration.Administration.TissueBankingConsent | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-detailshttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-details | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.ClinicalPresentation.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.Spread.AdjacentOrganInvolvement.AdjacentOrganInvaded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.Spread.RegionalSpread.RegionalSpreadLocation | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.PreviousRelevantPathology.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.ClinicalFinding.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Tumour.Tumour.TumourSite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
HistopathologyRequestSoftTissueBiopsy.Tumour.TumourDepth.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Tumour.TumourDimensions.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Specimen.Specimen.Collection.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
HistopathologyRequestSoftTissueBiopsy.Specimen.ClinicalImpression.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Specimen.AncillaryStudies.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation |
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 |
---|---|---|---|---|
HistopathologyRequestSoftTissueBiopsy | 0..* | Base | Soft tissue (biopsy) - Histopathology request Instances of this logical model are not marked to be the target of a Reference | |
PatientDetails | 1..1 | BackboneElement | Patient details | |
@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 |
Patient | 0..1 | BackboneElement | A short summary of the main identifying details for a patient.. | |
@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 |
Nhi | 1..1 | Identifier | A unique identifier assigned to a person by the NHI system. | |
NZName | 1..1 | BackboneElement | A person’s name details | |
@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 | |
OtherGivenName | 0..* | string | The person’s other given names or middle name and initials, but not the family name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameSuffix | 0..* | string | The suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership | |
PreferredNameIndicator | 0..1 | CodeableConcept | An indicator used to denote that a particular person name is the person’s preferred name | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | SectionPathologyPatient.Patient.NZName.age | |
NameInfoSource | 0..1 | CodeableConcept | A code indicating the name source | |
NameEffectivePeriod | 0..1 | Period | The date(s) the name is effective from and/or to | |
BirthdatePlace | 0..1 | BackboneElement | A person’s birth details | |
@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 |
DOB | 0..1 | date | The date on which the person was born | |
DOBInfoSource | 0..1 | CodeableConcept | A code indicating the origin of date of birth information | |
PlaceBirth | 0..1 | string | The town, suburb, city etc where the person was born | |
CountryBirthCode | 0..1 | CodeableConcept | Country where the person was born | |
CountryBirthInfoSource | 0..1 | CodeableConcept | A code indicating the source of information supporting the code for country of birth | |
Age | 0..1 | integer | The age of the patient at the time the data was recorded. | |
Gender | 0..1 | code | A classification of the person's gender as self-identified by the person | |
Sex | 0..1 | CodeableConcept | 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). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred) | |
Ethnicity | 1..* | CodeableConcept | A classification of the ethnicity of an individual person as self-identified by the person Binding: https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity (preferred) | |
Address | 0..* | BackboneElement | The person's current address or location details if known (in NZ CIQ address profile format. | |
@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 |
Type | 0..1 | CodeableConcept | The type of address, e.g. residential (physical), mailing (postal) | |
BuildingName | 0..1 | string | The name of the building or institution. | |
StreetAddress1 | 0..1 | string | The floor, unit and/or street address details. | |
StreetAddress2 | 0..1 | string | Other geographic information related to the address | |
Suburb | 0..1 | string | The name of the suburb or district within a city/town. | |
City | 0..1 | CodeableConcept | SectionPathologyPatient.Patient.Address.City | |
Postcode | 0..1 | string | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. | |
CountryCode | 0..1 | code | The two character ISO code that forms part of the address. | |
AddressProtectedFlag | 0..1 | boolean | This indicator denotes that the person’s address information is to be held ‘in confidence’ | |
PermanentAddressFlag | 0..1 | CodeableConcept | An indicator used to denote an address is a permanent address | |
DateAddressPeriod | 0..1 | Period | Date(s) that an address is effective from and/or to | |
DomicileCode | 0..1 | CodeableConcept | New Zealand health domicile code representing a person’s usual residential address | |
PrimaryAddressFlag | 0..1 | CodeableConcept | An indicator used to denote that the address is the primary address for the person | |
Title | 0..1 | string | SectionPathologyPatient.Patient.Title | |
Administration | 1..1 | BackboneElement | Administration | |
@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 |
Administration | 1..1 | BackboneElement | Administration details as seen on a pathology request form. | |
@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 |
DocumentId | 0..* | Identifier | A version-independent identifier for the document | |
LocalDocumentIdentifier | 0..1 | Identifier | A local identifier of the document that is unique only at the facility at which the document is created. | |
Version | 0..1 | string | An explicitly assigned identifier of a variation of the content in the document. | |
Author | 0..1 | BackboneElement | The healthcare practitioner who authored of the document. | |
@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 | SectionPathologyRequestAdministration.Administration.Author.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. | |
AuthoredDate | 0..1 | dateTime | The date on which this version of the document was authored. | |
Status | 1..1 | code | The status of the document (as defined by HL7 FHIR) | |
Category | 0..* | CodeableConcept | The high-level kind of the document, e.g. pathology request, pathology report, treatment plan. | |
Type | 1..1 | CodeableConcept | The specific type of document, e.g. breast pathology request for biopsy specimens | |
Encounter | 0..1 | Identifier | The patient encounter associated with this document. | |
Requester | 0..1 | BackboneElement | The healthcare practitioner who is requesting the service. | |
@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 | SectionPathologyRequestAdministration.Administration.Requester.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. | |
Performer | 0..* | BackboneElement | The healthcare practitioner and/or facility from whom the service is being requested. | |
@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 | SectionPathologyRequestAdministration.Administration.Performer.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. | |
CopyTo | 0..* | BackboneElement | Any healthcare practitioners to whom a copy of the report should be sent (in addition to the requester). | |
@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 | SectionPathologyRequestAdministration.Administration.CopyTo.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. | |
Intent | 1..1 | CodeableConcept | The main purpose of the service requested, e.g. diagnostic, treatment | |
InvestigationCategory | 0..1 | CodeableConcept | The high-level kind of investigation requested, e.g. radiology, pathology, surgery. | |
InvestigationType | 1..1 | CodeableConcept | The type of investigation requested, e.g. ultrasound, histology, cytology, colonoscopy. | |
TissueBankingConsent | 0..1 | CodeableConcept | Whether or not the patient has consented to have their tissue stored for future research (either specified or unspecified). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-details (preferred) | |
TissueReturnRequest | 0..1 | CodeableConcept | Whether or not the patient has requested to have their tissue returned to them, e.g. return, don't return, partial return. | |
ClinicalInformation | 1..1 | BackboneElement | Clinical information | |
@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 |
ClinicalPresentation | 0..1 | BackboneElement | Relevant clinical symptoms or findings that the patient presents with, e.g.lump. | |
@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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
testbool | 0..1 | boolean | SoftTissueBiopsyHistoClinicalInformation.ClinicalPresentation.testbool | |
Spread | 0..1 | BackboneElement | Details about how far and where the cancer has spread. | |
@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 |
AdjacentOrganInvolvement | 0..1 | BackboneElement | Details about any adjacent organ involvement of the primary tumour. | |
@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 |
AdjacentOrganInvolvement | 0..1 | CodeableConcept | Whether or not the tumour has invaded into adjacent organs. | |
AdjacentOrganInvaded | 0..* | CodeableConcept | Which adjacent organs the tumour has invaded. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography (preferred) | |
Comments | 0..1 | string | Free text comments that describe whether or not the tumour has invaded adjacent organs, and if so which ones. | |
RegionalSpread | 0..1 | BackboneElement | Details about any regional spread of the primary tumour. | |
@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 |
RegionalSpreadLocation | 0..1 | CodeableConcept | The regional location(s) in the body to which the primary cancer has spread. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography (preferred) | |
Comments | 0..1 | string | Free text comments about the regional spread of the tumour. | |
DistantMetastasis | 0..1 | BackboneElement | Details about any distant metastasis of the primary tumour. | |
@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 | 0..1 | CodeableConcept | Whether or not the tumour has spread to a distant organ. | |
DistantMetastasisLocation | 0..* | CodeableConcept | The distant location(s) in the body to which the primary cancer has spread. | |
Comments | 0..1 | string | Free text comments about any distant metastasis of the tumour. | |
PreviousRelevantPathology | 0..1 | BackboneElement | Any pathology results that are relevant to this histopathology request. | |
@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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Radiology | 0..1 | BackboneElement | The radiologic imaging used to examine parts of the body to aid diagnosis and guide treatment plans. | |
@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 |
Comments | 0..1 | string | Free text comments about the radiology imaging procedure and/or their results. | |
ClinicalFinding | 0..1 | BackboneElement | Any additional clinical information that is relevant to the histopathology request. | |
@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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Tumour | 1..* | BackboneElement | Tumour | |
@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 |
Tumour | 0..1 | BackboneElement | An abnormal change and/or damage in a body structure or tissue. | |
@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 |
TumourId | 0..1 | string | The number or identifier used to reference the given lesion/tumour. | |
TumourSite | 0..1 | BackboneElement | The body location of the lesion/tumour. | |
@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 |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
newElement | 0..1 | string | SoftTissueBiopsyHistoTumour.Tumour.TumourSite.newElement | |
Comments | 0..1 | string | Free text comments about the lesion/tumour. | |
TumourDepth | 0..1 | BackboneElement | The deepest layer in which the tumour is present. | |
@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) | |
TumourIdentifier | 0..1 | Identifier | An identifier for the tumour about which the observation is made. | |
TumourDepthStatus | 1..1 | CodeableConcept | Whether or not the tumour depth (tumour plane) is able to be assessed. | |
TumourDepth | 0..* | CodeableConcept | The deepest layer in which the tumour is present. | |
TumourDimensions | 0..1 | BackboneElement | The size of the tumour measured in one or more dimension. | |
@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) | |
TumourIdentifier | 0..1 | Identifier | An identifier for the tumour about which the observation is made. | |
TumourDimensionsStatus | 0..1 | CodeableConcept | Whether or not the tumour dimensions have been measured. | |
MaximumTumourDimension | 0..1 | Quantity | A measurement of the largest dimension of the tumour. | |
Dimension | 0..* | BackboneElement | A measurement of one of the dimensions of the tumour. | |
@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 |
Type | 1..1 | CodeableConcept | The type of dimension in which this measurement was taken, e.g. length, width, depth. | |
Size | 1..1 | Quantity | The size of the lesion in the given dimension. | |
Specimen | 1..* | BackboneElement | 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 |
Specimen | 0..1 | BackboneElement | A sample to be used for analysis. | |
@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..* | Identifier | An identifier for the specimen, e.g. a barcode. | |
TumourIdentifier | 0..* | string | The number or identifier used to reference the given lesion/tumour. | |
Category | 0..1 | CodeableConcept | The category of specimen, e.g. biopsy specimen | |
Type | 0..1 | CodeableConcept | The type of specimen, e.g. core biopsy specimen, lymph node excision specimen. | |
Qualifier | 0..1 | CodeableConcept | A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified. | |
Collection | 0..1 | BackboneElement | Details about the collection of 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 |
CollectionDate | 0..1 | dateTime | The date and/or time that the sample/specimen was collected. | |
BodySite | 0..1 | BackboneElement | The site from which the sample/specimen was collected. | |
@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 |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
newElement | 0..1 | string | SoftTissueBiopsyHistoSpecimen.Specimen.Collection.BodySite.newElement | |
Technique | 0..* | CodeableConcept | The technique used to collect the specimen, e.g. Random specimen collection. | |
ContainerQuantity | 0..1 | Quantity | A count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection. | |
Comments | 0..1 | string | Free text comments about the specimen. | |
SpecimenContainer | 0..* | BackboneElement | An individual container (e.g. a specific tube) in which the specimen is placed. | |
@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 |
ContainerId | 0..1 | Identifier | An identifier for the individual specimen container. | |
SpecimenId | 0..1 | Identifier | An identifier for the specimen in the container. | |
SpecimenQualifier | 0..1 | CodeableConcept | A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified. | |
PreparationTechnique | 0..* | CodeableConcept | SoftTissueBiopsyHistoSpecimen.SpecimenContainer.PreparationTechnique | |
MediumStatus | 0..1 | CodeableConcept | Whether or not the specimen is fresh or in a medium. | |
MediumType | 0..1 | CodeableConcept | The type of medium used for the specimen in the container. | |
Quantity | 0..1 | Quantity | The quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container. | |
ClinicalImpression | 0..1 | BackboneElement | The suspected behaviour of the specimen, e.g. benign, in situ, malignant. | |
@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. | |
Value | 1..1 | CodeableConcept | The suspected behaviour of the specimen, e.g. benign, in situ, malignant. | |
AncillaryStudies | 0..* | BackboneElement | A diagnostic test on a specimen, which is supplementary to the main 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 ancillary study. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HistopathologyRequestSoftTissueBiopsy.PatientDetails.Patient.Sex | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sexhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex | |
HistopathologyRequestSoftTissueBiopsy.PatientDetails.Patient.Ethnicity | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicityhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |
HistopathologyRequestSoftTissueBiopsy.Administration.Administration.TissueBankingConsent | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-detailshttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-details | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.ClinicalPresentation.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.Spread.AdjacentOrganInvolvement.AdjacentOrganInvaded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.Spread.RegionalSpread.RegionalSpreadLocation | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.PreviousRelevantPathology.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.ClinicalFinding.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Tumour.Tumour.TumourSite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
HistopathologyRequestSoftTissueBiopsy.Tumour.TumourDepth.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Tumour.TumourDimensions.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Specimen.Specimen.Collection.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
HistopathologyRequestSoftTissueBiopsy.Specimen.ClinicalImpression.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Specimen.AncillaryStudies.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation |
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 |
---|---|---|---|---|
HistopathologyRequestSoftTissueBiopsy | 0..* | Base | Soft tissue (biopsy) - Histopathology request Instances of this logical model are not marked to be the target of a Reference | |
PatientDetails | 1..1 | BackboneElement | Patient details | |
Patient | 0..1 | BackboneElement | A short summary of the main identifying details for a patient.. | |
Nhi | 1..1 | Identifier | A unique identifier assigned to a person by the NHI system. | |
NZName | 1..1 | BackboneElement | A person’s name details | |
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 | |
OtherGivenName | 0..* | string | The person’s other given names or middle name and initials, but not the family name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameSuffix | 0..* | string | The suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership | |
PreferredNameIndicator | 0..1 | CodeableConcept | An indicator used to denote that a particular person name is the person’s preferred name | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | SectionPathologyPatient.Patient.NZName.age | |
NameInfoSource | 0..1 | CodeableConcept | A code indicating the name source | |
NameEffectivePeriod | 0..1 | Period | The date(s) the name is effective from and/or to | |
BirthdatePlace | 0..1 | BackboneElement | A person’s birth details | |
DOB | 0..1 | date | The date on which the person was born | |
DOBInfoSource | 0..1 | CodeableConcept | A code indicating the origin of date of birth information | |
PlaceBirth | 0..1 | string | The town, suburb, city etc where the person was born | |
CountryBirthCode | 0..1 | CodeableConcept | Country where the person was born | |
CountryBirthInfoSource | 0..1 | CodeableConcept | A code indicating the source of information supporting the code for country of birth | |
Age | 0..1 | integer | The age of the patient at the time the data was recorded. | |
Gender | 0..1 | code | A classification of the person's gender as self-identified by the person | |
Sex | 0..1 | CodeableConcept | 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). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred) | |
Ethnicity | 1..* | CodeableConcept | A classification of the ethnicity of an individual person as self-identified by the person Binding: https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity (preferred) | |
Address | 0..* | BackboneElement | The person's current address or location details if known (in NZ CIQ address profile format. | |
Type | 0..1 | CodeableConcept | The type of address, e.g. residential (physical), mailing (postal) | |
BuildingName | 0..1 | string | The name of the building or institution. | |
StreetAddress1 | 0..1 | string | The floor, unit and/or street address details. | |
StreetAddress2 | 0..1 | string | Other geographic information related to the address | |
Suburb | 0..1 | string | The name of the suburb or district within a city/town. | |
City | 0..1 | CodeableConcept | SectionPathologyPatient.Patient.Address.City | |
Postcode | 0..1 | string | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. | |
CountryCode | 0..1 | code | The two character ISO code that forms part of the address. | |
AddressProtectedFlag | 0..1 | boolean | This indicator denotes that the person’s address information is to be held ‘in confidence’ | |
PermanentAddressFlag | 0..1 | CodeableConcept | An indicator used to denote an address is a permanent address | |
DateAddressPeriod | 0..1 | Period | Date(s) that an address is effective from and/or to | |
DomicileCode | 0..1 | CodeableConcept | New Zealand health domicile code representing a person’s usual residential address | |
PrimaryAddressFlag | 0..1 | CodeableConcept | An indicator used to denote that the address is the primary address for the person | |
Title | 0..1 | string | SectionPathologyPatient.Patient.Title | |
Administration | 1..1 | BackboneElement | Administration | |
Administration | 1..1 | BackboneElement | Administration details as seen on a pathology request form. | |
DocumentId | 0..* | Identifier | A version-independent identifier for the document | |
LocalDocumentIdentifier | 0..1 | Identifier | A local identifier of the document that is unique only at the facility at which the document is created. | |
Version | 0..1 | string | An explicitly assigned identifier of a variation of the content in the document. | |
Author | 0..1 | BackboneElement | The healthcare practitioner who authored of the document. | |
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 | SectionPathologyRequestAdministration.Administration.Author.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. | |
AuthoredDate | 0..1 | dateTime | The date on which this version of the document was authored. | |
Status | 1..1 | code | The status of the document (as defined by HL7 FHIR) | |
Category | 0..* | CodeableConcept | The high-level kind of the document, e.g. pathology request, pathology report, treatment plan. | |
Type | 1..1 | CodeableConcept | The specific type of document, e.g. breast pathology request for biopsy specimens | |
Encounter | 0..1 | Identifier | The patient encounter associated with this document. | |
Requester | 0..1 | BackboneElement | The healthcare practitioner who is requesting the service. | |
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 | SectionPathologyRequestAdministration.Administration.Requester.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. | |
Performer | 0..* | BackboneElement | The healthcare practitioner and/or facility from whom the service is being requested. | |
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 | SectionPathologyRequestAdministration.Administration.Performer.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. | |
CopyTo | 0..* | BackboneElement | Any healthcare practitioners to whom a copy of the report should be sent (in addition to the requester). | |
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 | SectionPathologyRequestAdministration.Administration.CopyTo.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. | |
Intent | 1..1 | CodeableConcept | The main purpose of the service requested, e.g. diagnostic, treatment | |
InvestigationCategory | 0..1 | CodeableConcept | The high-level kind of investigation requested, e.g. radiology, pathology, surgery. | |
InvestigationType | 1..1 | CodeableConcept | The type of investigation requested, e.g. ultrasound, histology, cytology, colonoscopy. | |
TissueBankingConsent | 0..1 | CodeableConcept | Whether or not the patient has consented to have their tissue stored for future research (either specified or unspecified). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-details (preferred) | |
TissueReturnRequest | 0..1 | CodeableConcept | Whether or not the patient has requested to have their tissue returned to them, e.g. return, don't return, partial return. | |
ClinicalInformation | 1..1 | BackboneElement | Clinical information | |
ClinicalPresentation | 0..1 | BackboneElement | Relevant clinical symptoms or findings that the patient presents with, e.g.lump. | |
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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
testbool | 0..1 | boolean | SoftTissueBiopsyHistoClinicalInformation.ClinicalPresentation.testbool | |
Spread | 0..1 | BackboneElement | Details about how far and where the cancer has spread. | |
AdjacentOrganInvolvement | 0..1 | BackboneElement | Details about any adjacent organ involvement of the primary tumour. | |
AdjacentOrganInvolvement | 0..1 | CodeableConcept | Whether or not the tumour has invaded into adjacent organs. | |
AdjacentOrganInvaded | 0..* | CodeableConcept | Which adjacent organs the tumour has invaded. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography (preferred) | |
Comments | 0..1 | string | Free text comments that describe whether or not the tumour has invaded adjacent organs, and if so which ones. | |
RegionalSpread | 0..1 | BackboneElement | Details about any regional spread of the primary tumour. | |
RegionalSpreadLocation | 0..1 | CodeableConcept | The regional location(s) in the body to which the primary cancer has spread. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography (preferred) | |
Comments | 0..1 | string | Free text comments about the regional spread of the tumour. | |
DistantMetastasis | 0..1 | BackboneElement | Details about any distant metastasis of the primary tumour. | |
Status | 0..1 | CodeableConcept | Whether or not the tumour has spread to a distant organ. | |
DistantMetastasisLocation | 0..* | CodeableConcept | The distant location(s) in the body to which the primary cancer has spread. | |
Comments | 0..1 | string | Free text comments about any distant metastasis of the tumour. | |
PreviousRelevantPathology | 0..1 | BackboneElement | Any pathology results that are relevant to this histopathology request. | |
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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Radiology | 0..1 | BackboneElement | The radiologic imaging used to examine parts of the body to aid diagnosis and guide treatment plans. | |
Comments | 0..1 | string | Free text comments about the radiology imaging procedure and/or their results. | |
ClinicalFinding | 0..1 | BackboneElement | Any additional clinical information that is relevant to the histopathology request. | |
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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Tumour | 1..* | BackboneElement | Tumour | |
Tumour | 0..1 | BackboneElement | An abnormal change and/or damage in a body structure or tissue. | |
TumourId | 0..1 | string | The number or identifier used to reference the given lesion/tumour. | |
TumourSite | 0..1 | BackboneElement | The body location of the lesion/tumour. | |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
newElement | 0..1 | string | SoftTissueBiopsyHistoTumour.Tumour.TumourSite.newElement | |
Comments | 0..1 | string | Free text comments about the lesion/tumour. | |
TumourDepth | 0..1 | BackboneElement | The deepest layer in which the tumour is present. | |
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) | |
TumourIdentifier | 0..1 | Identifier | An identifier for the tumour about which the observation is made. | |
TumourDepthStatus | 1..1 | CodeableConcept | Whether or not the tumour depth (tumour plane) is able to be assessed. | |
TumourDepth | 0..* | CodeableConcept | The deepest layer in which the tumour is present. | |
TumourDimensions | 0..1 | BackboneElement | The size of the tumour measured in one or more dimension. | |
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) | |
TumourIdentifier | 0..1 | Identifier | An identifier for the tumour about which the observation is made. | |
TumourDimensionsStatus | 0..1 | CodeableConcept | Whether or not the tumour dimensions have been measured. | |
MaximumTumourDimension | 0..1 | Quantity | A measurement of the largest dimension of the tumour. | |
Dimension | 0..* | BackboneElement | A measurement of one of the dimensions of the tumour. | |
Type | 1..1 | CodeableConcept | The type of dimension in which this measurement was taken, e.g. length, width, depth. | |
Size | 1..1 | Quantity | The size of the lesion in the given dimension. | |
Specimen | 1..* | BackboneElement | Specimen | |
Specimen | 0..1 | BackboneElement | A sample to be used for analysis. | |
Id | 0..* | Identifier | An identifier for the specimen, e.g. a barcode. | |
TumourIdentifier | 0..* | string | The number or identifier used to reference the given lesion/tumour. | |
Category | 0..1 | CodeableConcept | The category of specimen, e.g. biopsy specimen | |
Type | 0..1 | CodeableConcept | The type of specimen, e.g. core biopsy specimen, lymph node excision specimen. | |
Qualifier | 0..1 | CodeableConcept | A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified. | |
Collection | 0..1 | BackboneElement | Details about the collection of the specimen. | |
CollectionDate | 0..1 | dateTime | The date and/or time that the sample/specimen was collected. | |
BodySite | 0..1 | BackboneElement | The site from which the sample/specimen was collected. | |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
newElement | 0..1 | string | SoftTissueBiopsyHistoSpecimen.Specimen.Collection.BodySite.newElement | |
Technique | 0..* | CodeableConcept | The technique used to collect the specimen, e.g. Random specimen collection. | |
ContainerQuantity | 0..1 | Quantity | A count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection. | |
Comments | 0..1 | string | Free text comments about the specimen. | |
SpecimenContainer | 0..* | BackboneElement | An individual container (e.g. a specific tube) in which the specimen is placed. | |
ContainerId | 0..1 | Identifier | An identifier for the individual specimen container. | |
SpecimenId | 0..1 | Identifier | An identifier for the specimen in the container. | |
SpecimenQualifier | 0..1 | CodeableConcept | A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified. | |
PreparationTechnique | 0..* | CodeableConcept | SoftTissueBiopsyHistoSpecimen.SpecimenContainer.PreparationTechnique | |
MediumStatus | 0..1 | CodeableConcept | Whether or not the specimen is fresh or in a medium. | |
MediumType | 0..1 | CodeableConcept | The type of medium used for the specimen in the container. | |
Quantity | 0..1 | Quantity | The quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container. | |
ClinicalImpression | 0..1 | BackboneElement | The suspected behaviour of the specimen, e.g. benign, in situ, malignant. | |
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. | |
Value | 1..1 | CodeableConcept | The suspected behaviour of the specimen, e.g. benign, in situ, malignant. | |
AncillaryStudies | 0..* | BackboneElement | A diagnostic test on a specimen, which is supplementary to the main 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 ancillary study. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HistopathologyRequestSoftTissueBiopsy.PatientDetails.Patient.Sex | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sexhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex | |
HistopathologyRequestSoftTissueBiopsy.PatientDetails.Patient.Ethnicity | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicityhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |
HistopathologyRequestSoftTissueBiopsy.Administration.Administration.TissueBankingConsent | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-detailshttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-details | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.ClinicalPresentation.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.Spread.AdjacentOrganInvolvement.AdjacentOrganInvaded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.Spread.RegionalSpread.RegionalSpreadLocation | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.PreviousRelevantPathology.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.ClinicalFinding.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Tumour.Tumour.TumourSite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
HistopathologyRequestSoftTissueBiopsy.Tumour.TumourDepth.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Tumour.TumourDimensions.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Specimen.Specimen.Collection.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
HistopathologyRequestSoftTissueBiopsy.Specimen.ClinicalImpression.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Specimen.AncillaryStudies.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 |
---|---|---|---|---|
HistopathologyRequestSoftTissueBiopsy | 0..* | Base | Soft tissue (biopsy) - Histopathology request Instances of this logical model are not marked to be the target of a Reference | |
PatientDetails | 1..1 | BackboneElement | Patient details | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Patient | 0..1 | BackboneElement | A short summary of the main identifying details for a patient.. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Nhi | 1..1 | Identifier | A unique identifier assigned to a person by the NHI system. | |
NZName | 1..1 | BackboneElement | A person’s name details | |
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 | |
OtherGivenName | 0..* | string | The person’s other given names or middle name and initials, but not the family name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameSuffix | 0..* | string | The suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership | |
PreferredNameIndicator | 0..1 | CodeableConcept | An indicator used to denote that a particular person name is the person’s preferred name | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | SectionPathologyPatient.Patient.NZName.age | |
NameInfoSource | 0..1 | CodeableConcept | A code indicating the name source | |
NameEffectivePeriod | 0..1 | Period | The date(s) the name is effective from and/or to | |
BirthdatePlace | 0..1 | BackboneElement | A person’s birth details | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
DOB | 0..1 | date | The date on which the person was born | |
DOBInfoSource | 0..1 | CodeableConcept | A code indicating the origin of date of birth information | |
PlaceBirth | 0..1 | string | The town, suburb, city etc where the person was born | |
CountryBirthCode | 0..1 | CodeableConcept | Country where the person was born | |
CountryBirthInfoSource | 0..1 | CodeableConcept | A code indicating the source of information supporting the code for country of birth | |
Age | 0..1 | integer | The age of the patient at the time the data was recorded. | |
Gender | 0..1 | code | A classification of the person's gender as self-identified by the person | |
Sex | 0..1 | CodeableConcept | 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). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred) | |
Ethnicity | 1..* | CodeableConcept | A classification of the ethnicity of an individual person as self-identified by the person Binding: https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity (preferred) | |
Address | 0..* | BackboneElement | The person's current address or location details if known (in NZ CIQ address profile format. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Type | 0..1 | CodeableConcept | The type of address, e.g. residential (physical), mailing (postal) | |
BuildingName | 0..1 | string | The name of the building or institution. | |
StreetAddress1 | 0..1 | string | The floor, unit and/or street address details. | |
StreetAddress2 | 0..1 | string | Other geographic information related to the address | |
Suburb | 0..1 | string | The name of the suburb or district within a city/town. | |
City | 0..1 | CodeableConcept | SectionPathologyPatient.Patient.Address.City | |
Postcode | 0..1 | string | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. | |
CountryCode | 0..1 | code | The two character ISO code that forms part of the address. | |
AddressProtectedFlag | 0..1 | boolean | This indicator denotes that the person’s address information is to be held ‘in confidence’ | |
PermanentAddressFlag | 0..1 | CodeableConcept | An indicator used to denote an address is a permanent address | |
DateAddressPeriod | 0..1 | Period | Date(s) that an address is effective from and/or to | |
DomicileCode | 0..1 | CodeableConcept | New Zealand health domicile code representing a person’s usual residential address | |
PrimaryAddressFlag | 0..1 | CodeableConcept | An indicator used to denote that the address is the primary address for the person | |
Title | 0..1 | string | SectionPathologyPatient.Patient.Title | |
Administration | 1..1 | BackboneElement | Administration | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Administration | 1..1 | BackboneElement | Administration details as seen on a pathology request form. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
DocumentId | 0..* | Identifier | A version-independent identifier for the document | |
LocalDocumentIdentifier | 0..1 | Identifier | A local identifier of the document that is unique only at the facility at which the document is created. | |
Version | 0..1 | string | An explicitly assigned identifier of a variation of the content in the document. | |
Author | 0..1 | BackboneElement | The healthcare practitioner who authored of the document. | |
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 | SectionPathologyRequestAdministration.Administration.Author.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. | |
AuthoredDate | 0..1 | dateTime | The date on which this version of the document was authored. | |
Status | 1..1 | code | The status of the document (as defined by HL7 FHIR) | |
Category | 0..* | CodeableConcept | The high-level kind of the document, e.g. pathology request, pathology report, treatment plan. | |
Type | 1..1 | CodeableConcept | The specific type of document, e.g. breast pathology request for biopsy specimens | |
Encounter | 0..1 | Identifier | The patient encounter associated with this document. | |
Requester | 0..1 | BackboneElement | The healthcare practitioner who is requesting the service. | |
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 | SectionPathologyRequestAdministration.Administration.Requester.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. | |
Performer | 0..* | BackboneElement | The healthcare practitioner and/or facility from whom the service is being requested. | |
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 | SectionPathologyRequestAdministration.Administration.Performer.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. | |
CopyTo | 0..* | BackboneElement | Any healthcare practitioners to whom a copy of the report should be sent (in addition to the requester). | |
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 | SectionPathologyRequestAdministration.Administration.CopyTo.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. | |
Intent | 1..1 | CodeableConcept | The main purpose of the service requested, e.g. diagnostic, treatment | |
InvestigationCategory | 0..1 | CodeableConcept | The high-level kind of investigation requested, e.g. radiology, pathology, surgery. | |
InvestigationType | 1..1 | CodeableConcept | The type of investigation requested, e.g. ultrasound, histology, cytology, colonoscopy. | |
TissueBankingConsent | 0..1 | CodeableConcept | Whether or not the patient has consented to have their tissue stored for future research (either specified or unspecified). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-details (preferred) | |
TissueReturnRequest | 0..1 | CodeableConcept | Whether or not the patient has requested to have their tissue returned to them, e.g. return, don't return, partial return. | |
ClinicalInformation | 1..1 | BackboneElement | Clinical information | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
ClinicalPresentation | 0..1 | BackboneElement | Relevant clinical symptoms or findings that the patient presents with, e.g.lump. | |
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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
testbool | 0..1 | boolean | SoftTissueBiopsyHistoClinicalInformation.ClinicalPresentation.testbool | |
Spread | 0..1 | BackboneElement | Details about how far and where the cancer has spread. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
AdjacentOrganInvolvement | 0..1 | BackboneElement | Details about any adjacent organ involvement of the primary tumour. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
AdjacentOrganInvolvement | 0..1 | CodeableConcept | Whether or not the tumour has invaded into adjacent organs. | |
AdjacentOrganInvaded | 0..* | CodeableConcept | Which adjacent organs the tumour has invaded. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography (preferred) | |
Comments | 0..1 | string | Free text comments that describe whether or not the tumour has invaded adjacent organs, and if so which ones. | |
RegionalSpread | 0..1 | BackboneElement | Details about any regional spread of the primary tumour. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
RegionalSpreadLocation | 0..1 | CodeableConcept | The regional location(s) in the body to which the primary cancer has spread. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography (preferred) | |
Comments | 0..1 | string | Free text comments about the regional spread of the tumour. | |
DistantMetastasis | 0..1 | BackboneElement | Details about any distant metastasis of the primary tumour. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Status | 0..1 | CodeableConcept | Whether or not the tumour has spread to a distant organ. | |
DistantMetastasisLocation | 0..* | CodeableConcept | The distant location(s) in the body to which the primary cancer has spread. | |
Comments | 0..1 | string | Free text comments about any distant metastasis of the tumour. | |
PreviousRelevantPathology | 0..1 | BackboneElement | Any pathology results that are relevant to this histopathology request. | |
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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Radiology | 0..1 | BackboneElement | The radiologic imaging used to examine parts of the body to aid diagnosis and guide treatment plans. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Comments | 0..1 | string | Free text comments about the radiology imaging procedure and/or their results. | |
ClinicalFinding | 0..1 | BackboneElement | Any additional clinical information that is relevant to the histopathology request. | |
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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Tumour | 1..* | BackboneElement | Tumour | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Tumour | 0..1 | BackboneElement | An abnormal change and/or damage in a body structure or tissue. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
TumourId | 0..1 | string | The number or identifier used to reference the given lesion/tumour. | |
TumourSite | 0..1 | BackboneElement | The body location of the lesion/tumour. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
newElement | 0..1 | string | SoftTissueBiopsyHistoTumour.Tumour.TumourSite.newElement | |
Comments | 0..1 | string | Free text comments about the lesion/tumour. | |
TumourDepth | 0..1 | BackboneElement | The deepest layer in which the tumour is present. | |
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) | |
TumourIdentifier | 0..1 | Identifier | An identifier for the tumour about which the observation is made. | |
TumourDepthStatus | 1..1 | CodeableConcept | Whether or not the tumour depth (tumour plane) is able to be assessed. | |
TumourDepth | 0..* | CodeableConcept | The deepest layer in which the tumour is present. | |
TumourDimensions | 0..1 | BackboneElement | The size of the tumour measured in one or more dimension. | |
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) | |
TumourIdentifier | 0..1 | Identifier | An identifier for the tumour about which the observation is made. | |
TumourDimensionsStatus | 0..1 | CodeableConcept | Whether or not the tumour dimensions have been measured. | |
MaximumTumourDimension | 0..1 | Quantity | A measurement of the largest dimension of the tumour. | |
Dimension | 0..* | BackboneElement | A measurement of one of the dimensions of the tumour. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Type | 1..1 | CodeableConcept | The type of dimension in which this measurement was taken, e.g. length, width, depth. | |
Size | 1..1 | Quantity | The size of the lesion in the given dimension. | |
Specimen | 1..* | BackboneElement | Specimen | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Specimen | 0..1 | BackboneElement | A sample to be used for analysis. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Id | 0..* | Identifier | An identifier for the specimen, e.g. a barcode. | |
TumourIdentifier | 0..* | string | The number or identifier used to reference the given lesion/tumour. | |
Category | 0..1 | CodeableConcept | The category of specimen, e.g. biopsy specimen | |
Type | 0..1 | CodeableConcept | The type of specimen, e.g. core biopsy specimen, lymph node excision specimen. | |
Qualifier | 0..1 | CodeableConcept | A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified. | |
Collection | 0..1 | BackboneElement | Details about the collection of the specimen. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
CollectionDate | 0..1 | dateTime | The date and/or time that the sample/specimen was collected. | |
BodySite | 0..1 | BackboneElement | The site from which the sample/specimen was collected. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
newElement | 0..1 | string | SoftTissueBiopsyHistoSpecimen.Specimen.Collection.BodySite.newElement | |
Technique | 0..* | CodeableConcept | The technique used to collect the specimen, e.g. Random specimen collection. | |
ContainerQuantity | 0..1 | Quantity | A count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection. | |
Comments | 0..1 | string | Free text comments about the specimen. | |
SpecimenContainer | 0..* | BackboneElement | An individual container (e.g. a specific tube) in which the specimen is placed. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
ContainerId | 0..1 | Identifier | An identifier for the individual specimen container. | |
SpecimenId | 0..1 | Identifier | An identifier for the specimen in the container. | |
SpecimenQualifier | 0..1 | CodeableConcept | A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified. | |
PreparationTechnique | 0..* | CodeableConcept | SoftTissueBiopsyHistoSpecimen.SpecimenContainer.PreparationTechnique | |
MediumStatus | 0..1 | CodeableConcept | Whether or not the specimen is fresh or in a medium. | |
MediumType | 0..1 | CodeableConcept | The type of medium used for the specimen in the container. | |
Quantity | 0..1 | Quantity | The quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container. | |
ClinicalImpression | 0..1 | BackboneElement | The suspected behaviour of the specimen, e.g. benign, in situ, malignant. | |
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. | |
Value | 1..1 | CodeableConcept | The suspected behaviour of the specimen, e.g. benign, in situ, malignant. | |
AncillaryStudies | 0..* | BackboneElement | A diagnostic test on a specimen, which is supplementary to the main 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 ancillary study. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HistopathologyRequestSoftTissueBiopsy.PatientDetails.Patient.Sex | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sexhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex | |
HistopathologyRequestSoftTissueBiopsy.PatientDetails.Patient.Ethnicity | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicityhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |
HistopathologyRequestSoftTissueBiopsy.Administration.Administration.TissueBankingConsent | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-detailshttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-details | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.ClinicalPresentation.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.Spread.AdjacentOrganInvolvement.AdjacentOrganInvaded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.Spread.RegionalSpread.RegionalSpreadLocation | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.PreviousRelevantPathology.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.ClinicalFinding.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Tumour.Tumour.TumourSite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
HistopathologyRequestSoftTissueBiopsy.Tumour.TumourDepth.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Tumour.TumourDimensions.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Specimen.Specimen.Collection.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
HistopathologyRequestSoftTissueBiopsy.Specimen.ClinicalImpression.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Specimen.AncillaryStudies.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation |
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 |
---|---|---|---|---|
HistopathologyRequestSoftTissueBiopsy | 0..* | Base | Soft tissue (biopsy) - Histopathology request Instances of this logical model are not marked to be the target of a Reference | |
PatientDetails | 1..1 | BackboneElement | Patient details | |
@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 |
Patient | 0..1 | BackboneElement | A short summary of the main identifying details for a patient.. | |
@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 |
Nhi | 1..1 | Identifier | A unique identifier assigned to a person by the NHI system. | |
NZName | 1..1 | BackboneElement | A person’s name details | |
@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 | |
OtherGivenName | 0..* | string | The person’s other given names or middle name and initials, but not the family name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameSuffix | 0..* | string | The suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership | |
PreferredNameIndicator | 0..1 | CodeableConcept | An indicator used to denote that a particular person name is the person’s preferred name | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | SectionPathologyPatient.Patient.NZName.age | |
NameInfoSource | 0..1 | CodeableConcept | A code indicating the name source | |
NameEffectivePeriod | 0..1 | Period | The date(s) the name is effective from and/or to | |
BirthdatePlace | 0..1 | BackboneElement | A person’s birth details | |
@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 |
DOB | 0..1 | date | The date on which the person was born | |
DOBInfoSource | 0..1 | CodeableConcept | A code indicating the origin of date of birth information | |
PlaceBirth | 0..1 | string | The town, suburb, city etc where the person was born | |
CountryBirthCode | 0..1 | CodeableConcept | Country where the person was born | |
CountryBirthInfoSource | 0..1 | CodeableConcept | A code indicating the source of information supporting the code for country of birth | |
Age | 0..1 | integer | The age of the patient at the time the data was recorded. | |
Gender | 0..1 | code | A classification of the person's gender as self-identified by the person | |
Sex | 0..1 | CodeableConcept | 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). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred) | |
Ethnicity | 1..* | CodeableConcept | A classification of the ethnicity of an individual person as self-identified by the person Binding: https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity (preferred) | |
Address | 0..* | BackboneElement | The person's current address or location details if known (in NZ CIQ address profile format. | |
@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 |
Type | 0..1 | CodeableConcept | The type of address, e.g. residential (physical), mailing (postal) | |
BuildingName | 0..1 | string | The name of the building or institution. | |
StreetAddress1 | 0..1 | string | The floor, unit and/or street address details. | |
StreetAddress2 | 0..1 | string | Other geographic information related to the address | |
Suburb | 0..1 | string | The name of the suburb or district within a city/town. | |
City | 0..1 | CodeableConcept | SectionPathologyPatient.Patient.Address.City | |
Postcode | 0..1 | string | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. | |
CountryCode | 0..1 | code | The two character ISO code that forms part of the address. | |
AddressProtectedFlag | 0..1 | boolean | This indicator denotes that the person’s address information is to be held ‘in confidence’ | |
PermanentAddressFlag | 0..1 | CodeableConcept | An indicator used to denote an address is a permanent address | |
DateAddressPeriod | 0..1 | Period | Date(s) that an address is effective from and/or to | |
DomicileCode | 0..1 | CodeableConcept | New Zealand health domicile code representing a person’s usual residential address | |
PrimaryAddressFlag | 0..1 | CodeableConcept | An indicator used to denote that the address is the primary address for the person | |
Title | 0..1 | string | SectionPathologyPatient.Patient.Title | |
Administration | 1..1 | BackboneElement | Administration | |
@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 |
Administration | 1..1 | BackboneElement | Administration details as seen on a pathology request form. | |
@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 |
DocumentId | 0..* | Identifier | A version-independent identifier for the document | |
LocalDocumentIdentifier | 0..1 | Identifier | A local identifier of the document that is unique only at the facility at which the document is created. | |
Version | 0..1 | string | An explicitly assigned identifier of a variation of the content in the document. | |
Author | 0..1 | BackboneElement | The healthcare practitioner who authored of the document. | |
@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 | SectionPathologyRequestAdministration.Administration.Author.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. | |
AuthoredDate | 0..1 | dateTime | The date on which this version of the document was authored. | |
Status | 1..1 | code | The status of the document (as defined by HL7 FHIR) | |
Category | 0..* | CodeableConcept | The high-level kind of the document, e.g. pathology request, pathology report, treatment plan. | |
Type | 1..1 | CodeableConcept | The specific type of document, e.g. breast pathology request for biopsy specimens | |
Encounter | 0..1 | Identifier | The patient encounter associated with this document. | |
Requester | 0..1 | BackboneElement | The healthcare practitioner who is requesting the service. | |
@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 | SectionPathologyRequestAdministration.Administration.Requester.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. | |
Performer | 0..* | BackboneElement | The healthcare practitioner and/or facility from whom the service is being requested. | |
@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 | SectionPathologyRequestAdministration.Administration.Performer.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. | |
CopyTo | 0..* | BackboneElement | Any healthcare practitioners to whom a copy of the report should be sent (in addition to the requester). | |
@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 | SectionPathologyRequestAdministration.Administration.CopyTo.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. | |
Intent | 1..1 | CodeableConcept | The main purpose of the service requested, e.g. diagnostic, treatment | |
InvestigationCategory | 0..1 | CodeableConcept | The high-level kind of investigation requested, e.g. radiology, pathology, surgery. | |
InvestigationType | 1..1 | CodeableConcept | The type of investigation requested, e.g. ultrasound, histology, cytology, colonoscopy. | |
TissueBankingConsent | 0..1 | CodeableConcept | Whether or not the patient has consented to have their tissue stored for future research (either specified or unspecified). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-details (preferred) | |
TissueReturnRequest | 0..1 | CodeableConcept | Whether or not the patient has requested to have their tissue returned to them, e.g. return, don't return, partial return. | |
ClinicalInformation | 1..1 | BackboneElement | Clinical information | |
@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 |
ClinicalPresentation | 0..1 | BackboneElement | Relevant clinical symptoms or findings that the patient presents with, e.g.lump. | |
@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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
testbool | 0..1 | boolean | SoftTissueBiopsyHistoClinicalInformation.ClinicalPresentation.testbool | |
Spread | 0..1 | BackboneElement | Details about how far and where the cancer has spread. | |
@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 |
AdjacentOrganInvolvement | 0..1 | BackboneElement | Details about any adjacent organ involvement of the primary tumour. | |
@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 |
AdjacentOrganInvolvement | 0..1 | CodeableConcept | Whether or not the tumour has invaded into adjacent organs. | |
AdjacentOrganInvaded | 0..* | CodeableConcept | Which adjacent organs the tumour has invaded. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography (preferred) | |
Comments | 0..1 | string | Free text comments that describe whether or not the tumour has invaded adjacent organs, and if so which ones. | |
RegionalSpread | 0..1 | BackboneElement | Details about any regional spread of the primary tumour. | |
@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 |
RegionalSpreadLocation | 0..1 | CodeableConcept | The regional location(s) in the body to which the primary cancer has spread. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography (preferred) | |
Comments | 0..1 | string | Free text comments about the regional spread of the tumour. | |
DistantMetastasis | 0..1 | BackboneElement | Details about any distant metastasis of the primary tumour. | |
@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 | 0..1 | CodeableConcept | Whether or not the tumour has spread to a distant organ. | |
DistantMetastasisLocation | 0..* | CodeableConcept | The distant location(s) in the body to which the primary cancer has spread. | |
Comments | 0..1 | string | Free text comments about any distant metastasis of the tumour. | |
PreviousRelevantPathology | 0..1 | BackboneElement | Any pathology results that are relevant to this histopathology request. | |
@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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Radiology | 0..1 | BackboneElement | The radiologic imaging used to examine parts of the body to aid diagnosis and guide treatment plans. | |
@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 |
Comments | 0..1 | string | Free text comments about the radiology imaging procedure and/or their results. | |
ClinicalFinding | 0..1 | BackboneElement | Any additional clinical information that is relevant to the histopathology request. | |
@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) | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Tumour | 1..* | BackboneElement | Tumour | |
@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 |
Tumour | 0..1 | BackboneElement | An abnormal change and/or damage in a body structure or tissue. | |
@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 |
TumourId | 0..1 | string | The number or identifier used to reference the given lesion/tumour. | |
TumourSite | 0..1 | BackboneElement | The body location of the lesion/tumour. | |
@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 |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
newElement | 0..1 | string | SoftTissueBiopsyHistoTumour.Tumour.TumourSite.newElement | |
Comments | 0..1 | string | Free text comments about the lesion/tumour. | |
TumourDepth | 0..1 | BackboneElement | The deepest layer in which the tumour is present. | |
@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) | |
TumourIdentifier | 0..1 | Identifier | An identifier for the tumour about which the observation is made. | |
TumourDepthStatus | 1..1 | CodeableConcept | Whether or not the tumour depth (tumour plane) is able to be assessed. | |
TumourDepth | 0..* | CodeableConcept | The deepest layer in which the tumour is present. | |
TumourDimensions | 0..1 | BackboneElement | The size of the tumour measured in one or more dimension. | |
@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) | |
TumourIdentifier | 0..1 | Identifier | An identifier for the tumour about which the observation is made. | |
TumourDimensionsStatus | 0..1 | CodeableConcept | Whether or not the tumour dimensions have been measured. | |
MaximumTumourDimension | 0..1 | Quantity | A measurement of the largest dimension of the tumour. | |
Dimension | 0..* | BackboneElement | A measurement of one of the dimensions of the tumour. | |
@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 |
Type | 1..1 | CodeableConcept | The type of dimension in which this measurement was taken, e.g. length, width, depth. | |
Size | 1..1 | Quantity | The size of the lesion in the given dimension. | |
Specimen | 1..* | BackboneElement | 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 |
Specimen | 0..1 | BackboneElement | A sample to be used for analysis. | |
@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..* | Identifier | An identifier for the specimen, e.g. a barcode. | |
TumourIdentifier | 0..* | string | The number or identifier used to reference the given lesion/tumour. | |
Category | 0..1 | CodeableConcept | The category of specimen, e.g. biopsy specimen | |
Type | 0..1 | CodeableConcept | The type of specimen, e.g. core biopsy specimen, lymph node excision specimen. | |
Qualifier | 0..1 | CodeableConcept | A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified. | |
Collection | 0..1 | BackboneElement | Details about the collection of 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 |
CollectionDate | 0..1 | dateTime | The date and/or time that the sample/specimen was collected. | |
BodySite | 0..1 | BackboneElement | The site from which the sample/specimen was collected. | |
@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 |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
newElement | 0..1 | string | SoftTissueBiopsyHistoSpecimen.Specimen.Collection.BodySite.newElement | |
Technique | 0..* | CodeableConcept | The technique used to collect the specimen, e.g. Random specimen collection. | |
ContainerQuantity | 0..1 | Quantity | A count of the number of containers (e.g. 3 tubes, 4 slides, 1 bottle) in which the specimen is placed after collection. | |
Comments | 0..1 | string | Free text comments about the specimen. | |
SpecimenContainer | 0..* | BackboneElement | An individual container (e.g. a specific tube) in which the specimen is placed. | |
@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 |
ContainerId | 0..1 | Identifier | An identifier for the individual specimen container. | |
SpecimenId | 0..1 | Identifier | An identifier for the specimen in the container. | |
SpecimenQualifier | 0..1 | CodeableConcept | A qualifying characteristic of the specimen, e.g. sessile, pedunculated, calcified, non-calcified. | |
PreparationTechnique | 0..* | CodeableConcept | SoftTissueBiopsyHistoSpecimen.SpecimenContainer.PreparationTechnique | |
MediumStatus | 0..1 | CodeableConcept | Whether or not the specimen is fresh or in a medium. | |
MediumType | 0..1 | CodeableConcept | The type of medium used for the specimen in the container. | |
Quantity | 0..1 | Quantity | The quantity of specimen (volume, weight or count of pieces/fragments) placed in this individual container. | |
ClinicalImpression | 0..1 | BackboneElement | The suspected behaviour of the specimen, e.g. benign, in situ, malignant. | |
@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. | |
Value | 1..1 | CodeableConcept | The suspected behaviour of the specimen, e.g. benign, in situ, malignant. | |
AncillaryStudies | 0..* | BackboneElement | A diagnostic test on a specimen, which is supplementary to the main 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 ancillary study. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HistopathologyRequestSoftTissueBiopsy.PatientDetails.Patient.Sex | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sexhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex | |
HistopathologyRequestSoftTissueBiopsy.PatientDetails.Patient.Ethnicity | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicityhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity | |
HistopathologyRequestSoftTissueBiopsy.Administration.Administration.TissueBankingConsent | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-detailshttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-consent-details | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.ClinicalPresentation.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.Spread.AdjacentOrganInvolvement.AdjacentOrganInvaded | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.Spread.RegionalSpread.RegionalSpreadLocation | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-high-level-topography | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.PreviousRelevantPathology.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.ClinicalInformation.ClinicalFinding.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Tumour.Tumour.TumourSite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
HistopathologyRequestSoftTissueBiopsy.Tumour.TumourDepth.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Tumour.TumourDimensions.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Specimen.Specimen.Collection.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
HistopathologyRequestSoftTissueBiopsy.Specimen.ClinicalImpression.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation | |
HistopathologyRequestSoftTissueBiopsy.Specimen.AncillaryStudies.Code | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observationhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation |
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