CanShare models
0.1.0 - ci-build

CanShare models, published by David hay. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/davidhay25/models/ and changes regularly. See the Directory of published versions

Logical Model: my ancillary

Official URL: http://example.org/StructureDefinition/Myancillary-cs Version: 0.1.0
Draft as of 2024-03-04 Computable Name: Myancillary_cs

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Myancillary-cs 0..*Basemy ancillary
Instances of this logical model are not marked to be the target of a Reference
... AncillaryStudy 0..1BackboneElementRelevant information about diagnostic tests on a soft tissue specimen which are supplementary to the main test.
.... AncillaryStudiesStatus 1..1CodeableConceptWhether or not any ancillary studies have been performed on the given specimen.
.... AncillaryStudiesPerformedTypes 0..*CodeableConceptA list of which types of ancillary studies have been performed.
.... AncillaryStudiesPerformed 0..*BackboneElementThe ancillary studies that have been performed on the specimen.
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
..... Date 0..1dateTimeThe date and/or time that the observation was performed.
..... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
...... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
...... PersonName 0..1BackboneElementPerson 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..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
....... GivenName 0..1stringThe person’s forename or given name at birth
....... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
....... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
....... age 0..1stringmyancillary.AncillaryStudy.AncillaryStudiesPerformed.PerformedBy.PersonName.age
...... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
....... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
....... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
....... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
..... Comments 0..1stringPlain text comments about the observation.
..... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
..... SpecimenSentForObservation 0..1booleanWhether or not the specimen has been sent for observation.
..... Immunohistochemistry 0..*BackboneElementThe immunohistochemistry tests that have been performed on the specimen.
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
...... NotPerformedReason 0..1CodeableConceptThe reason why the immunohistochemistry test was not performed.
...... ResultString 0..1stringFree text description of the result of the immunohistochemistry test.
..... MolecularyFindings 0..*BackboneElementThe molecular tests that have been performed on the specimen.
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
...... NotPerformedReason 0..1CodeableConceptThe reason why the molecular test was not performed.
...... ResultString 0..1stringFree text description of the result of the molecular test.
..... Other 0..*BackboneElementAny other ancillary studies that have been performed on the specimen.
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
...... NotPerformedReason 0..1CodeableConceptThe reason why the ancillary test was not performed.
...... ResultString 0..1stringFree text description of the result of the ancillary test.
.... Comments 0..1stringAny additional free text comments about the ancillary studies.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.MolecularyFindings.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.Other.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
NameFlagsCard.TypeDescription & Constraintsdoco
.. Myancillary-cs 0..*Basemy ancillary
Instances of this logical model are not marked to be the target of a Reference
... AncillaryStudy 0..1BackboneElementRelevant information about diagnostic tests on a soft tissue specimen which are supplementary to the main test.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... AncillaryStudiesStatus 1..1CodeableConceptWhether or not any ancillary studies have been performed on the given specimen.
.... AncillaryStudiesPerformedTypes 0..*CodeableConceptA list of which types of ancillary studies have been performed.
.... AncillaryStudiesPerformed 0..*BackboneElementThe ancillary studies that have been performed on the specimen.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
..... Date 0..1dateTimeThe date and/or time that the observation was performed.
..... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
...... PersonName 0..1BackboneElementPerson 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..*ExtensionExtensions that cannot be ignored even if unrecognized
....... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
....... GivenName 0..1stringThe person’s forename or given name at birth
....... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
....... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
....... age 0..1stringmyancillary.AncillaryStudy.AncillaryStudiesPerformed.PerformedBy.PersonName.age
...... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
....... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
....... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
..... Comments 0..1stringPlain text comments about the observation.
..... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
..... SpecimenSentForObservation 0..1booleanWhether or not the specimen has been sent for observation.
..... Immunohistochemistry 0..*BackboneElementThe immunohistochemistry tests that have been performed on the specimen.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
...... NotPerformedReason 0..1CodeableConceptThe reason why the immunohistochemistry test was not performed.
...... ResultString 0..1stringFree text description of the result of the immunohistochemistry test.
..... MolecularyFindings 0..*BackboneElementThe molecular tests that have been performed on the specimen.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
...... NotPerformedReason 0..1CodeableConceptThe reason why the molecular test was not performed.
...... ResultString 0..1stringFree text description of the result of the molecular test.
..... Other 0..*BackboneElementAny other ancillary studies that have been performed on the specimen.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
...... NotPerformedReason 0..1CodeableConceptThe reason why the ancillary test was not performed.
...... ResultString 0..1stringFree text description of the result of the ancillary test.
.... Comments 0..1stringAny additional free text comments about the ancillary studies.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.MolecularyFindings.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.Other.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Myancillary-cs 0..*Basemy ancillary
Instances of this logical model are not marked to be the target of a Reference
... AncillaryStudy 0..1BackboneElementRelevant information about diagnostic tests on a soft tissue specimen which are supplementary to the main test.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... AncillaryStudiesStatus 1..1CodeableConceptWhether or not any ancillary studies have been performed on the given specimen.
.... AncillaryStudiesPerformedTypes 0..*CodeableConceptA list of which types of ancillary studies have been performed.
.... AncillaryStudiesPerformed 0..*BackboneElementThe ancillary studies that have been performed on the specimen.
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
..... Date 0..1dateTimeThe date and/or time that the observation was performed.
..... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
...... PersonName 0..1BackboneElementPerson 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..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
....... GivenName 0..1stringThe person’s forename or given name at birth
....... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
....... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
....... age 0..1stringmyancillary.AncillaryStudy.AncillaryStudiesPerformed.PerformedBy.PersonName.age
...... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
....... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
....... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
..... Comments 0..1stringPlain text comments about the observation.
..... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
..... SpecimenSentForObservation 0..1booleanWhether or not the specimen has been sent for observation.
..... Immunohistochemistry 0..*BackboneElementThe immunohistochemistry tests that have been performed on the specimen.
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
...... NotPerformedReason 0..1CodeableConceptThe reason why the immunohistochemistry test was not performed.
...... ResultString 0..1stringFree text description of the result of the immunohistochemistry test.
..... MolecularyFindings 0..*BackboneElementThe molecular tests that have been performed on the specimen.
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
...... NotPerformedReason 0..1CodeableConceptThe reason why the molecular test was not performed.
...... ResultString 0..1stringFree text description of the result of the molecular test.
..... Other 0..*BackboneElementAny other ancillary studies that have been performed on the specimen.
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
...... NotPerformedReason 0..1CodeableConceptThe reason why the ancillary test was not performed.
...... ResultString 0..1stringFree text description of the result of the ancillary test.
.... Comments 0..1stringAny additional free text comments about the ancillary studies.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.MolecularyFindings.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.Other.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (11 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Myancillary-cs 0..*Basemy ancillary
Instances of this logical model are not marked to be the target of a Reference
... AncillaryStudy 0..1BackboneElementRelevant information about diagnostic tests on a soft tissue specimen which are supplementary to the main test.
.... AncillaryStudiesStatus 1..1CodeableConceptWhether or not any ancillary studies have been performed on the given specimen.
.... AncillaryStudiesPerformedTypes 0..*CodeableConceptA list of which types of ancillary studies have been performed.
.... AncillaryStudiesPerformed 0..*BackboneElementThe ancillary studies that have been performed on the specimen.
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
..... Date 0..1dateTimeThe date and/or time that the observation was performed.
..... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
...... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
...... PersonName 0..1BackboneElementPerson 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..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
....... GivenName 0..1stringThe person’s forename or given name at birth
....... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
....... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
....... age 0..1stringmyancillary.AncillaryStudy.AncillaryStudiesPerformed.PerformedBy.PersonName.age
...... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
....... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
....... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
....... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
..... Comments 0..1stringPlain text comments about the observation.
..... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
..... SpecimenSentForObservation 0..1booleanWhether or not the specimen has been sent for observation.
..... Immunohistochemistry 0..*BackboneElementThe immunohistochemistry tests that have been performed on the specimen.
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
...... NotPerformedReason 0..1CodeableConceptThe reason why the immunohistochemistry test was not performed.
...... ResultString 0..1stringFree text description of the result of the immunohistochemistry test.
..... MolecularyFindings 0..*BackboneElementThe molecular tests that have been performed on the specimen.
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
...... NotPerformedReason 0..1CodeableConceptThe reason why the molecular test was not performed.
...... ResultString 0..1stringFree text description of the result of the molecular test.
..... Other 0..*BackboneElementAny other ancillary studies that have been performed on the specimen.
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
...... NotPerformedReason 0..1CodeableConceptThe reason why the ancillary test was not performed.
...... ResultString 0..1stringFree text description of the result of the ancillary test.
.... Comments 0..1stringAny additional free text comments about the ancillary studies.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.MolecularyFindings.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.Other.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Myancillary-cs 0..*Basemy ancillary
Instances of this logical model are not marked to be the target of a Reference
... AncillaryStudy 0..1BackboneElementRelevant information about diagnostic tests on a soft tissue specimen which are supplementary to the main test.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... AncillaryStudiesStatus 1..1CodeableConceptWhether or not any ancillary studies have been performed on the given specimen.
.... AncillaryStudiesPerformedTypes 0..*CodeableConceptA list of which types of ancillary studies have been performed.
.... AncillaryStudiesPerformed 0..*BackboneElementThe ancillary studies that have been performed on the specimen.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
..... Date 0..1dateTimeThe date and/or time that the observation was performed.
..... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
...... PersonName 0..1BackboneElementPerson 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..*ExtensionExtensions that cannot be ignored even if unrecognized
....... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
....... GivenName 0..1stringThe person’s forename or given name at birth
....... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
....... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
....... age 0..1stringmyancillary.AncillaryStudy.AncillaryStudiesPerformed.PerformedBy.PersonName.age
...... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
....... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
....... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
..... Comments 0..1stringPlain text comments about the observation.
..... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
..... SpecimenSentForObservation 0..1booleanWhether or not the specimen has been sent for observation.
..... Immunohistochemistry 0..*BackboneElementThe immunohistochemistry tests that have been performed on the specimen.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
...... NotPerformedReason 0..1CodeableConceptThe reason why the immunohistochemistry test was not performed.
...... ResultString 0..1stringFree text description of the result of the immunohistochemistry test.
..... MolecularyFindings 0..*BackboneElementThe molecular tests that have been performed on the specimen.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
...... NotPerformedReason 0..1CodeableConceptThe reason why the molecular test was not performed.
...... ResultString 0..1stringFree text description of the result of the molecular test.
..... Other 0..*BackboneElementAny other ancillary studies that have been performed on the specimen.
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
...... NotPerformedReason 0..1CodeableConceptThe reason why the ancillary test was not performed.
...... ResultString 0..1stringFree text description of the result of the ancillary test.
.... Comments 0..1stringAny additional free text comments about the ancillary studies.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.MolecularyFindings.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.Other.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Myancillary-cs 0..*Basemy ancillary
Instances of this logical model are not marked to be the target of a Reference
... AncillaryStudy 0..1BackboneElementRelevant information about diagnostic tests on a soft tissue specimen which are supplementary to the main test.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... AncillaryStudiesStatus 1..1CodeableConceptWhether or not any ancillary studies have been performed on the given specimen.
.... AncillaryStudiesPerformedTypes 0..*CodeableConceptA list of which types of ancillary studies have been performed.
.... AncillaryStudiesPerformed 0..*BackboneElementThe ancillary studies that have been performed on the specimen.
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Status 1..1CodeableConceptThe status of the observation
..... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
..... Method 0..1CodeableConceptThe technique, procedure, or system used to perform the observation.
..... Date 0..1dateTimeThe date and/or time that the observation was performed.
..... PerformedBy 0..*BackboneElementA person responsible for performing the observation.
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
...... PersonName 0..1BackboneElementPerson 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..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
....... GivenName 0..1stringThe person’s forename or given name at birth
....... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
....... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
....... age 0..1stringmyancillary.AncillaryStudy.AncillaryStudiesPerformed.PerformedBy.PersonName.age
...... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
...... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
....... RoleCode 1..1CodeableConceptThe designated the role of a health worker
....... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
....... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.
..... Comments 0..1stringPlain text comments about the observation.
..... SpecimenId 0..1IdentifierAn identifier of the specimen being observed.
..... SpecimenSentForObservation 0..1booleanWhether or not the specimen has been sent for observation.
..... Immunohistochemistry 0..*BackboneElementThe immunohistochemistry tests that have been performed on the specimen.
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
...... NotPerformedReason 0..1CodeableConceptThe reason why the immunohistochemistry test was not performed.
...... ResultString 0..1stringFree text description of the result of the immunohistochemistry test.
..... MolecularyFindings 0..*BackboneElementThe molecular tests that have been performed on the specimen.
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
...... NotPerformedReason 0..1CodeableConceptThe reason why the molecular test was not performed.
...... ResultString 0..1stringFree text description of the result of the molecular test.
..... Other 0..*BackboneElementAny other ancillary studies that have been performed on the specimen.
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Status 1..1CodeableConceptThe status of the observation
...... Code 1..1CodeableConceptThe type of observation made.
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation (preferred)
...... NotPerformedReason 0..1CodeableConceptThe reason why the ancillary test was not performed.
...... ResultString 0..1stringFree text description of the result of the ancillary test.
.... Comments 0..1stringAny additional free text comments about the ancillary studies.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.MolecularyFindings.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
Myancillary-cs.AncillaryStudy.AncillaryStudiesPerformed.Other.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (11 nested mandatory elements)

 

Other representations of profile: CSV, Excel