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: Menopausal status

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

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

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
.. MenopausalStatus-cs 0..*BaseMenopausal status
Instances of this logical model are not marked to be the target of a Reference
... 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)
... Date 0..1dateTimeThe date and/or time that the observation was performed.
.... 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..1stringMenopausalStatus.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.
... Value 1..1CodeableConceptWhether or not the patient is pre or post menopausal.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MenopausalStatus-cs.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
NameFlagsCard.TypeDescription & Constraintsdoco
.. MenopausalStatus-cs 0..*BaseMenopausal status
Instances of this logical model are not marked to be the target of a Reference
... 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)
... Date 0..1dateTimeThe date and/or time that the observation was performed.
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... 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..1stringMenopausalStatus.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.
... Value 1..1CodeableConceptWhether or not the patient is pre or post menopausal.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MenopausalStatus-cs.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
MenopausalStatus-cs.PerformedBy.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard

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
.. MenopausalStatus-cs 0..*BaseMenopausal status
Instances of this logical model are not marked to be the target of a Reference
... 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)
... Date 0..1dateTimeThe date and/or time that the observation was performed.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... 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..1stringMenopausalStatus.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.
... Value 1..1CodeableConceptWhether or not the patient is pre or post menopausal.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MenopausalStatus-cs.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
MenopausalStatus-cs.PerformedBy.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MenopausalStatus-cs.PerformedBy.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

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 (5 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. MenopausalStatus-cs 0..*BaseMenopausal status
Instances of this logical model are not marked to be the target of a Reference
... 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)
... Date 0..1dateTimeThe date and/or time that the observation was performed.
.... 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..1stringMenopausalStatus.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.
... Value 1..1CodeableConceptWhether or not the patient is pre or post menopausal.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MenopausalStatus-cs.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MenopausalStatus-cs 0..*BaseMenopausal status
Instances of this logical model are not marked to be the target of a Reference
... 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)
... Date 0..1dateTimeThe date and/or time that the observation was performed.
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... 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..1stringMenopausalStatus.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.
... Value 1..1CodeableConceptWhether or not the patient is pre or post menopausal.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MenopausalStatus-cs.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
MenopausalStatus-cs.PerformedBy.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard

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
.. MenopausalStatus-cs 0..*BaseMenopausal status
Instances of this logical model are not marked to be the target of a Reference
... 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)
... Date 0..1dateTimeThe date and/or time that the observation was performed.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... 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..1stringMenopausalStatus.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.
... Value 1..1CodeableConceptWhether or not the patient is pre or post menopausal.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MenopausalStatus-cs.Codepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-observation
MenopausalStatus-cs.PerformedBy.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MenopausalStatus-cs.PerformedBy.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

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 (5 nested mandatory elements)

 

Other representations of profile: CSV, Excel