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/SurgicalProcedure-cs | Version: 0.1.0 | |||
Draft as of 2024-03-04 | Computable Name: SurgicalProcedure_cs |
A medical procedure performed by surgeon.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SurgicalProcedure-cs | 0..* | Base | Surgical procedure Instances of this logical model are not marked to be the target of a Reference | |
Status | 1..1 | code | The status of the procedure, e.g. preparation, in progress, not done, on hold, stopped, completed, entered in error, unknown. | |
Period | 0..1 | Period | The start and/or end date/time at which the procedure was performed. | |
Code | 0..1 | CodeableConcept | The type of procedure, e.g. Fine needle aspiration, axillary lymph node sampling, axillary lymph node dissection, colonoscopy. | |
Intent | 0..* | CodeableConcept | The purpose of the procedure, e.g. diagnostic, curative, palliative. | |
Reason | 0..* | CodeableConcept | The clinical reason (or indication) the procedure was performed (e.g. a lump, national bowel screening programme) | |
ReasonDetails | 0..1 | string | A free text description of the reason the procedure was requested. | |
PrimaryCancerDiagnosis | 0..1 | BackboneElement | The primary cancer diagnosis that is the focus of this procedure. | |
ClinicalStatus | 1..1 | code | The status of the condition, in terms of its clinical progression, i.e. active, recurrence, relapse, inactive, remission, resolved, unknown. | |
VerificationStatus | 0..1 | code | The status of the condition from a certainty perspective, i.e. unconfirmed, provisional, differential, confirmed, refuted, entered-in-error. | |
Comments | 0..1 | string | Free text comments about the medical condition. | |
DiagnosisDate | 0..1 | dateTime | The date (and optionally time) on which the medical conditions was first diagnosed. | |
BasisOfDiagnosis | 0..1 | CodeableConcept | The evidence on which the condition was diagnosed. | |
Code | 1..1 | CodeableConcept | The type of medical condition. | |
BodySite | 0..1 | BackboneElement | The location in the body where the condition is found. | |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
BodyStructurePart | 0..* | CodeableConcept | The anatomical part of the body structure being described. | |
Clockface | 0..1 | CodeableConcept | The clockface orientation from the landmark. | |
DistanceFromLandmark | 0..1 | Quantity | The distance from the given landmark. | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
Morphology | 0..1 | CodeableConcept | The form and structure of the cancer, as observed by a pathologist (e.g. histologic type, cytologic type) | |
Performer | 0..* | BackboneElement | The healthcare practitioner who performed the procedure. | |
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 | SurgicalProcedure.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. | |
Location | 0..1 | BackboneElement | The healthcare facility at which the procedure was performed. | |
NZBN | 0..1 | code | NZBN will in future be the master data source for most organisation | |
Id | 1..1 | Identifier | The identifier of the healthcare organisation. | |
OrganisationTypeCode | 1..1 | CodeableConcept | A code that describes the broad type of organisation in the context of the health system | |
Name | 0..* | BackboneElement | Details about the name of the organisation | |
OrganisationName | 1..1 | string | The name by which the organisation is known | |
NameProtectedFlag | 0..1 | code | This indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users | |
BodySite | 0..* | BackboneElement | The target body site(s) of the procedure | |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
BodyStructurePart | 0..* | CodeableConcept | The anatomical part of the body structure being described. | |
Clockface | 0..1 | CodeableConcept | The clockface orientation from the landmark. | |
DistanceFromLandmark | 0..1 | Quantity | The distance from the given landmark. | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
DeviceUsed | 0..* | CodeableConcept | A device used to perform the procedure. | |
Finding | 0..* | BackboneElement | A finding that has resulted from this procedure. | |
Status | 1..1 | CodeableConcept | The status of the observation | |
Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
Method | 0..1 | CodeableConcept | The technique, procedure, or system used to perform the observation. | |
Date | 0..1 | dateTime | The date and/or time that the observation was performed. | |
PerformedBy | 0..* | BackboneElement | A person responsible for performing the observation. | |
Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
PersonName | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
GivenName | 0..1 | string | The person’s forename or given name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | SurgicalProcedure.Finding.PerformedBy.PersonName.age | |
ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Comments | 0..1 | string | Free text comments about this procedure. | |
ReportId | 0..* | Identifier | The identifier of the report for this procedure. | |
SurgicalAccess | 0..1 | CodeableConcept | The route used to access the site of a procedure, e.g. open, laparoscopic. | |
Priority | 0..1 | CodeableConcept | The urgency with which the procedure needed to be performed, e.g. elective, urgent. | |
PriorityReason | 0..* | CodeableConcept | The clinical reason for the surgical procedure's priority. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
SurgicalProcedure-cs.PrimaryCancerDiagnosis.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
SurgicalProcedure-cs.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
SurgicalProcedure-cs.Finding.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 |
---|---|---|---|---|
SurgicalProcedure-cs | 0..* | Base | Surgical procedure Instances of this logical model are not marked to be the target of a Reference | |
Status | 1..1 | code | The status of the procedure, e.g. preparation, in progress, not done, on hold, stopped, completed, entered in error, unknown. | |
Period | 0..1 | Period | The start and/or end date/time at which the procedure was performed. | |
Code | 0..1 | CodeableConcept | The type of procedure, e.g. Fine needle aspiration, axillary lymph node sampling, axillary lymph node dissection, colonoscopy. | |
Intent | 0..* | CodeableConcept | The purpose of the procedure, e.g. diagnostic, curative, palliative. | |
Reason | 0..* | CodeableConcept | The clinical reason (or indication) the procedure was performed (e.g. a lump, national bowel screening programme) | |
ReasonDetails | 0..1 | string | A free text description of the reason the procedure was requested. | |
PrimaryCancerDiagnosis | 0..1 | BackboneElement | The primary cancer diagnosis that is the focus of this procedure. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
ClinicalStatus | 1..1 | code | The status of the condition, in terms of its clinical progression, i.e. active, recurrence, relapse, inactive, remission, resolved, unknown. | |
VerificationStatus | 0..1 | code | The status of the condition from a certainty perspective, i.e. unconfirmed, provisional, differential, confirmed, refuted, entered-in-error. | |
Comments | 0..1 | string | Free text comments about the medical condition. | |
DiagnosisDate | 0..1 | dateTime | The date (and optionally time) on which the medical conditions was first diagnosed. | |
BasisOfDiagnosis | 0..1 | CodeableConcept | The evidence on which the condition was diagnosed. | |
Code | 1..1 | CodeableConcept | The type of medical condition. | |
BodySite | 0..1 | BackboneElement | The location in the body where the condition is found. | |
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) | |
BodyStructurePart | 0..* | CodeableConcept | The anatomical part of the body structure being described. | |
Clockface | 0..1 | CodeableConcept | The clockface orientation from the landmark. | |
DistanceFromLandmark | 0..1 | Quantity | The distance from the given landmark. | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
Morphology | 0..1 | CodeableConcept | The form and structure of the cancer, as observed by a pathologist (e.g. histologic type, cytologic type) | |
Performer | 0..* | BackboneElement | The healthcare practitioner who performed the procedure. | |
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 | SurgicalProcedure.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. | |
Location | 0..1 | BackboneElement | The healthcare facility at which the procedure was performed. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
NZBN | 0..1 | code | NZBN will in future be the master data source for most organisation | |
Id | 1..1 | Identifier | The identifier of the healthcare organisation. | |
OrganisationTypeCode | 1..1 | CodeableConcept | A code that describes the broad type of organisation in the context of the health system | |
Name | 0..* | BackboneElement | Details about the name of the organisation | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
OrganisationName | 1..1 | string | The name by which the organisation is known | |
NameProtectedFlag | 0..1 | code | This indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users | |
BodySite | 0..* | BackboneElement | The target body site(s) of the procedure | |
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) | |
BodyStructurePart | 0..* | CodeableConcept | The anatomical part of the body structure being described. | |
Clockface | 0..1 | CodeableConcept | The clockface orientation from the landmark. | |
DistanceFromLandmark | 0..1 | Quantity | The distance from the given landmark. | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
DeviceUsed | 0..* | CodeableConcept | A device used to perform the procedure. | |
Finding | 0..* | BackboneElement | A finding that has resulted from this procedure. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Status | 1..1 | CodeableConcept | The status of the observation | |
Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
Method | 0..1 | CodeableConcept | The technique, procedure, or system used to perform the observation. | |
Date | 0..1 | dateTime | The date and/or time that the observation was performed. | |
PerformedBy | 0..* | BackboneElement | A person responsible for performing the observation. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
PersonName | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
GivenName | 0..1 | string | The person’s forename or given name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | SurgicalProcedure.Finding.PerformedBy.PersonName.age | |
ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Comments | 0..1 | string | Free text comments about this procedure. | |
ReportId | 0..* | Identifier | The identifier of the report for this procedure. | |
SurgicalAccess | 0..1 | CodeableConcept | The route used to access the site of a procedure, e.g. open, laparoscopic. | |
Priority | 0..1 | CodeableConcept | The urgency with which the procedure needed to be performed, e.g. elective, urgent. | |
PriorityReason | 0..* | CodeableConcept | The clinical reason for the surgical procedure's priority. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
SurgicalProcedure-cs.PrimaryCancerDiagnosis.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
SurgicalProcedure-cs.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
SurgicalProcedure-cs.Finding.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 |
---|---|---|---|---|
SurgicalProcedure-cs | 0..* | Base | Surgical procedure Instances of this logical model are not marked to be the target of a Reference | |
Status | 1..1 | code | The status of the procedure, e.g. preparation, in progress, not done, on hold, stopped, completed, entered in error, unknown. | |
Period | 0..1 | Period | The start and/or end date/time at which the procedure was performed. | |
Code | 0..1 | CodeableConcept | The type of procedure, e.g. Fine needle aspiration, axillary lymph node sampling, axillary lymph node dissection, colonoscopy. | |
Intent | 0..* | CodeableConcept | The purpose of the procedure, e.g. diagnostic, curative, palliative. | |
Reason | 0..* | CodeableConcept | The clinical reason (or indication) the procedure was performed (e.g. a lump, national bowel screening programme) | |
ReasonDetails | 0..1 | string | A free text description of the reason the procedure was requested. | |
PrimaryCancerDiagnosis | 0..1 | BackboneElement | The primary cancer diagnosis that is the focus of this procedure. | |
@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 |
ClinicalStatus | 1..1 | code | The status of the condition, in terms of its clinical progression, i.e. active, recurrence, relapse, inactive, remission, resolved, unknown. | |
VerificationStatus | 0..1 | code | The status of the condition from a certainty perspective, i.e. unconfirmed, provisional, differential, confirmed, refuted, entered-in-error. | |
Comments | 0..1 | string | Free text comments about the medical condition. | |
DiagnosisDate | 0..1 | dateTime | The date (and optionally time) on which the medical conditions was first diagnosed. | |
BasisOfDiagnosis | 0..1 | CodeableConcept | The evidence on which the condition was diagnosed. | |
Code | 1..1 | CodeableConcept | The type of medical condition. | |
BodySite | 0..1 | BackboneElement | The location in the body where the condition is found. | |
@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) | |
BodyStructurePart | 0..* | CodeableConcept | The anatomical part of the body structure being described. | |
Clockface | 0..1 | CodeableConcept | The clockface orientation from the landmark. | |
DistanceFromLandmark | 0..1 | Quantity | The distance from the given landmark. | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
Morphology | 0..1 | CodeableConcept | The form and structure of the cancer, as observed by a pathologist (e.g. histologic type, cytologic type) | |
Performer | 0..* | BackboneElement | The healthcare practitioner who performed the procedure. | |
@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 | SurgicalProcedure.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. | |
Location | 0..1 | BackboneElement | The healthcare facility at which the procedure was performed. | |
@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 |
NZBN | 0..1 | code | NZBN will in future be the master data source for most organisation | |
Id | 1..1 | Identifier | The identifier of the healthcare organisation. | |
OrganisationTypeCode | 1..1 | CodeableConcept | A code that describes the broad type of organisation in the context of the health system | |
Name | 0..* | BackboneElement | Details about the name of the organisation | |
@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 |
OrganisationName | 1..1 | string | The name by which the organisation is known | |
NameProtectedFlag | 0..1 | code | This indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users | |
BodySite | 0..* | BackboneElement | The target body site(s) of the procedure | |
@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) | |
BodyStructurePart | 0..* | CodeableConcept | The anatomical part of the body structure being described. | |
Clockface | 0..1 | CodeableConcept | The clockface orientation from the landmark. | |
DistanceFromLandmark | 0..1 | Quantity | The distance from the given landmark. | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
DeviceUsed | 0..* | CodeableConcept | A device used to perform the procedure. | |
Finding | 0..* | BackboneElement | A finding that has resulted from this procedure. | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Status | 1..1 | CodeableConcept | The status of the observation | |
Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
Method | 0..1 | CodeableConcept | The technique, procedure, or system used to perform the observation. | |
Date | 0..1 | dateTime | The date and/or time that the observation was performed. | |
PerformedBy | 0..* | BackboneElement | A person responsible for performing the observation. | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
PersonName | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
GivenName | 0..1 | string | The person’s forename or given name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | SurgicalProcedure.Finding.PerformedBy.PersonName.age | |
ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Comments | 0..1 | string | Free text comments about this procedure. | |
ReportId | 0..* | Identifier | The identifier of the report for this procedure. | |
SurgicalAccess | 0..1 | CodeableConcept | The route used to access the site of a procedure, e.g. open, laparoscopic. | |
Priority | 0..1 | CodeableConcept | The urgency with which the procedure needed to be performed, e.g. elective, urgent. | |
PriorityReason | 0..* | CodeableConcept | The clinical reason for the surgical procedure's priority. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
SurgicalProcedure-cs.PrimaryCancerDiagnosis.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
SurgicalProcedure-cs.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
SurgicalProcedure-cs.Finding.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 |
---|---|---|---|---|
SurgicalProcedure-cs | 0..* | Base | Surgical procedure Instances of this logical model are not marked to be the target of a Reference | |
Status | 1..1 | code | The status of the procedure, e.g. preparation, in progress, not done, on hold, stopped, completed, entered in error, unknown. | |
Period | 0..1 | Period | The start and/or end date/time at which the procedure was performed. | |
Code | 0..1 | CodeableConcept | The type of procedure, e.g. Fine needle aspiration, axillary lymph node sampling, axillary lymph node dissection, colonoscopy. | |
Intent | 0..* | CodeableConcept | The purpose of the procedure, e.g. diagnostic, curative, palliative. | |
Reason | 0..* | CodeableConcept | The clinical reason (or indication) the procedure was performed (e.g. a lump, national bowel screening programme) | |
ReasonDetails | 0..1 | string | A free text description of the reason the procedure was requested. | |
PrimaryCancerDiagnosis | 0..1 | BackboneElement | The primary cancer diagnosis that is the focus of this procedure. | |
ClinicalStatus | 1..1 | code | The status of the condition, in terms of its clinical progression, i.e. active, recurrence, relapse, inactive, remission, resolved, unknown. | |
VerificationStatus | 0..1 | code | The status of the condition from a certainty perspective, i.e. unconfirmed, provisional, differential, confirmed, refuted, entered-in-error. | |
Comments | 0..1 | string | Free text comments about the medical condition. | |
DiagnosisDate | 0..1 | dateTime | The date (and optionally time) on which the medical conditions was first diagnosed. | |
BasisOfDiagnosis | 0..1 | CodeableConcept | The evidence on which the condition was diagnosed. | |
Code | 1..1 | CodeableConcept | The type of medical condition. | |
BodySite | 0..1 | BackboneElement | The location in the body where the condition is found. | |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
BodyStructurePart | 0..* | CodeableConcept | The anatomical part of the body structure being described. | |
Clockface | 0..1 | CodeableConcept | The clockface orientation from the landmark. | |
DistanceFromLandmark | 0..1 | Quantity | The distance from the given landmark. | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
Morphology | 0..1 | CodeableConcept | The form and structure of the cancer, as observed by a pathologist (e.g. histologic type, cytologic type) | |
Performer | 0..* | BackboneElement | The healthcare practitioner who performed the procedure. | |
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 | SurgicalProcedure.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. | |
Location | 0..1 | BackboneElement | The healthcare facility at which the procedure was performed. | |
NZBN | 0..1 | code | NZBN will in future be the master data source for most organisation | |
Id | 1..1 | Identifier | The identifier of the healthcare organisation. | |
OrganisationTypeCode | 1..1 | CodeableConcept | A code that describes the broad type of organisation in the context of the health system | |
Name | 0..* | BackboneElement | Details about the name of the organisation | |
OrganisationName | 1..1 | string | The name by which the organisation is known | |
NameProtectedFlag | 0..1 | code | This indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users | |
BodySite | 0..* | BackboneElement | The target body site(s) of the procedure | |
BodyStructure | 1..1 | CodeableConcept | The anatomical structure being described Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography (preferred) | |
BodyStructurePart | 0..* | CodeableConcept | The anatomical part of the body structure being described. | |
Clockface | 0..1 | CodeableConcept | The clockface orientation from the landmark. | |
DistanceFromLandmark | 0..1 | Quantity | The distance from the given landmark. | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
DeviceUsed | 0..* | CodeableConcept | A device used to perform the procedure. | |
Finding | 0..* | BackboneElement | A finding that has resulted from this procedure. | |
Status | 1..1 | CodeableConcept | The status of the observation | |
Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
Method | 0..1 | CodeableConcept | The technique, procedure, or system used to perform the observation. | |
Date | 0..1 | dateTime | The date and/or time that the observation was performed. | |
PerformedBy | 0..* | BackboneElement | A person responsible for performing the observation. | |
Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
PersonName | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
GivenName | 0..1 | string | The person’s forename or given name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | SurgicalProcedure.Finding.PerformedBy.PersonName.age | |
ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Comments | 0..1 | string | Free text comments about this procedure. | |
ReportId | 0..* | Identifier | The identifier of the report for this procedure. | |
SurgicalAccess | 0..1 | CodeableConcept | The route used to access the site of a procedure, e.g. open, laparoscopic. | |
Priority | 0..1 | CodeableConcept | The urgency with which the procedure needed to be performed, e.g. elective, urgent. | |
PriorityReason | 0..* | CodeableConcept | The clinical reason for the surgical procedure's priority. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
SurgicalProcedure-cs.PrimaryCancerDiagnosis.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
SurgicalProcedure-cs.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
SurgicalProcedure-cs.Finding.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 |
---|---|---|---|---|
SurgicalProcedure-cs | 0..* | Base | Surgical procedure Instances of this logical model are not marked to be the target of a Reference | |
Status | 1..1 | code | The status of the procedure, e.g. preparation, in progress, not done, on hold, stopped, completed, entered in error, unknown. | |
Period | 0..1 | Period | The start and/or end date/time at which the procedure was performed. | |
Code | 0..1 | CodeableConcept | The type of procedure, e.g. Fine needle aspiration, axillary lymph node sampling, axillary lymph node dissection, colonoscopy. | |
Intent | 0..* | CodeableConcept | The purpose of the procedure, e.g. diagnostic, curative, palliative. | |
Reason | 0..* | CodeableConcept | The clinical reason (or indication) the procedure was performed (e.g. a lump, national bowel screening programme) | |
ReasonDetails | 0..1 | string | A free text description of the reason the procedure was requested. | |
PrimaryCancerDiagnosis | 0..1 | BackboneElement | The primary cancer diagnosis that is the focus of this procedure. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
ClinicalStatus | 1..1 | code | The status of the condition, in terms of its clinical progression, i.e. active, recurrence, relapse, inactive, remission, resolved, unknown. | |
VerificationStatus | 0..1 | code | The status of the condition from a certainty perspective, i.e. unconfirmed, provisional, differential, confirmed, refuted, entered-in-error. | |
Comments | 0..1 | string | Free text comments about the medical condition. | |
DiagnosisDate | 0..1 | dateTime | The date (and optionally time) on which the medical conditions was first diagnosed. | |
BasisOfDiagnosis | 0..1 | CodeableConcept | The evidence on which the condition was diagnosed. | |
Code | 1..1 | CodeableConcept | The type of medical condition. | |
BodySite | 0..1 | BackboneElement | The location in the body where the condition is found. | |
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) | |
BodyStructurePart | 0..* | CodeableConcept | The anatomical part of the body structure being described. | |
Clockface | 0..1 | CodeableConcept | The clockface orientation from the landmark. | |
DistanceFromLandmark | 0..1 | Quantity | The distance from the given landmark. | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
Morphology | 0..1 | CodeableConcept | The form and structure of the cancer, as observed by a pathologist (e.g. histologic type, cytologic type) | |
Performer | 0..* | BackboneElement | The healthcare practitioner who performed the procedure. | |
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 | SurgicalProcedure.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. | |
Location | 0..1 | BackboneElement | The healthcare facility at which the procedure was performed. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
NZBN | 0..1 | code | NZBN will in future be the master data source for most organisation | |
Id | 1..1 | Identifier | The identifier of the healthcare organisation. | |
OrganisationTypeCode | 1..1 | CodeableConcept | A code that describes the broad type of organisation in the context of the health system | |
Name | 0..* | BackboneElement | Details about the name of the organisation | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
OrganisationName | 1..1 | string | The name by which the organisation is known | |
NameProtectedFlag | 0..1 | code | This indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users | |
BodySite | 0..* | BackboneElement | The target body site(s) of the procedure | |
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) | |
BodyStructurePart | 0..* | CodeableConcept | The anatomical part of the body structure being described. | |
Clockface | 0..1 | CodeableConcept | The clockface orientation from the landmark. | |
DistanceFromLandmark | 0..1 | Quantity | The distance from the given landmark. | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
DeviceUsed | 0..* | CodeableConcept | A device used to perform the procedure. | |
Finding | 0..* | BackboneElement | A finding that has resulted from this procedure. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Status | 1..1 | CodeableConcept | The status of the observation | |
Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
Method | 0..1 | CodeableConcept | The technique, procedure, or system used to perform the observation. | |
Date | 0..1 | dateTime | The date and/or time that the observation was performed. | |
PerformedBy | 0..* | BackboneElement | A person responsible for performing the observation. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
PersonName | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
GivenName | 0..1 | string | The person’s forename or given name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | SurgicalProcedure.Finding.PerformedBy.PersonName.age | |
ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Comments | 0..1 | string | Free text comments about this procedure. | |
ReportId | 0..* | Identifier | The identifier of the report for this procedure. | |
SurgicalAccess | 0..1 | CodeableConcept | The route used to access the site of a procedure, e.g. open, laparoscopic. | |
Priority | 0..1 | CodeableConcept | The urgency with which the procedure needed to be performed, e.g. elective, urgent. | |
PriorityReason | 0..* | CodeableConcept | The clinical reason for the surgical procedure's priority. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
SurgicalProcedure-cs.PrimaryCancerDiagnosis.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
SurgicalProcedure-cs.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
SurgicalProcedure-cs.Finding.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 |
---|---|---|---|---|
SurgicalProcedure-cs | 0..* | Base | Surgical procedure Instances of this logical model are not marked to be the target of a Reference | |
Status | 1..1 | code | The status of the procedure, e.g. preparation, in progress, not done, on hold, stopped, completed, entered in error, unknown. | |
Period | 0..1 | Period | The start and/or end date/time at which the procedure was performed. | |
Code | 0..1 | CodeableConcept | The type of procedure, e.g. Fine needle aspiration, axillary lymph node sampling, axillary lymph node dissection, colonoscopy. | |
Intent | 0..* | CodeableConcept | The purpose of the procedure, e.g. diagnostic, curative, palliative. | |
Reason | 0..* | CodeableConcept | The clinical reason (or indication) the procedure was performed (e.g. a lump, national bowel screening programme) | |
ReasonDetails | 0..1 | string | A free text description of the reason the procedure was requested. | |
PrimaryCancerDiagnosis | 0..1 | BackboneElement | The primary cancer diagnosis that is the focus of this procedure. | |
@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 |
ClinicalStatus | 1..1 | code | The status of the condition, in terms of its clinical progression, i.e. active, recurrence, relapse, inactive, remission, resolved, unknown. | |
VerificationStatus | 0..1 | code | The status of the condition from a certainty perspective, i.e. unconfirmed, provisional, differential, confirmed, refuted, entered-in-error. | |
Comments | 0..1 | string | Free text comments about the medical condition. | |
DiagnosisDate | 0..1 | dateTime | The date (and optionally time) on which the medical conditions was first diagnosed. | |
BasisOfDiagnosis | 0..1 | CodeableConcept | The evidence on which the condition was diagnosed. | |
Code | 1..1 | CodeableConcept | The type of medical condition. | |
BodySite | 0..1 | BackboneElement | The location in the body where the condition is found. | |
@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) | |
BodyStructurePart | 0..* | CodeableConcept | The anatomical part of the body structure being described. | |
Clockface | 0..1 | CodeableConcept | The clockface orientation from the landmark. | |
DistanceFromLandmark | 0..1 | Quantity | The distance from the given landmark. | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
Morphology | 0..1 | CodeableConcept | The form and structure of the cancer, as observed by a pathologist (e.g. histologic type, cytologic type) | |
Performer | 0..* | BackboneElement | The healthcare practitioner who performed the procedure. | |
@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 | SurgicalProcedure.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. | |
Location | 0..1 | BackboneElement | The healthcare facility at which the procedure was performed. | |
@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 |
NZBN | 0..1 | code | NZBN will in future be the master data source for most organisation | |
Id | 1..1 | Identifier | The identifier of the healthcare organisation. | |
OrganisationTypeCode | 1..1 | CodeableConcept | A code that describes the broad type of organisation in the context of the health system | |
Name | 0..* | BackboneElement | Details about the name of the organisation | |
@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 |
OrganisationName | 1..1 | string | The name by which the organisation is known | |
NameProtectedFlag | 0..1 | code | This indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users | |
BodySite | 0..* | BackboneElement | The target body site(s) of the procedure | |
@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) | |
BodyStructurePart | 0..* | CodeableConcept | The anatomical part of the body structure being described. | |
Clockface | 0..1 | CodeableConcept | The clockface orientation from the landmark. | |
DistanceFromLandmark | 0..1 | Quantity | The distance from the given landmark. | |
Comments | 0..1 | CodeableConcept | Free text comments describing the body site. | |
DeviceUsed | 0..* | CodeableConcept | A device used to perform the procedure. | |
Finding | 0..* | BackboneElement | A finding that has resulted from this procedure. | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Status | 1..1 | CodeableConcept | The status of the observation | |
Code | 1..1 | CodeableConcept | The type of observation made. Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred) | |
Method | 0..1 | CodeableConcept | The technique, procedure, or system used to perform the observation. | |
Date | 0..1 | dateTime | The date and/or time that the observation was performed. | |
PerformedBy | 0..* | BackboneElement | A person responsible for performing the observation. | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Id | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
PersonName | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Title | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
GivenName | 0..1 | string | The person’s forename or given name at birth | |
FamilyName | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
NameProtectionFlag | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
age | 0..1 | string | SurgicalProcedure.Finding.PerformedBy.PersonName.age | |
ProfessionalRegistration | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
AssigningOrganisationIdentifier | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
HealthWorkerRole | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
PRI | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
RoleCode | 1..1 | CodeableConcept | The designated the role of a health worker | |
RoleConfidential | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
FacilityId | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
Comments | 0..1 | string | Plain text comments about the observation. | |
Comments | 0..1 | string | Free text comments about this procedure. | |
ReportId | 0..* | Identifier | The identifier of the report for this procedure. | |
SurgicalAccess | 0..1 | CodeableConcept | The route used to access the site of a procedure, e.g. open, laparoscopic. | |
Priority | 0..1 | CodeableConcept | The urgency with which the procedure needed to be performed, e.g. elective, urgent. | |
PriorityReason | 0..* | CodeableConcept | The clinical reason for the surgical procedure's priority. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
SurgicalProcedure-cs.PrimaryCancerDiagnosis.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
SurgicalProcedure-cs.BodySite.BodyStructure | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-topographyhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-topography | |
SurgicalProcedure-cs.Finding.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