Te Whatu Ora, Central Region Integration Hub
1.0.11-rc1 - ci-build New Zealand flag

Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.11-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions

ValueSet: NZ Central Region - Marital Status Value Set

Official URL: https://standards.digital.health.nz/fhir/central-region/ValueSet-marital-status Version: 1.0.11-rc1
Active as of 2024-09-11 Computable Name: NZCentralRegionMaritalStatusValueSet

Combined Marital Status value set with HL7 defined valueset plus #OTH from NullFlavor, as used in the Central Region

References

Logical Definition (CLD)

Generated Narrative: ValueSet nzcr-marital-status-vs

This value set includes codes based on the following rules:

  • Include all codes defined in http://terminology.hl7.org/CodeSystem/v3-MaritalStatus
  • Include these codes as defined in http://terminology.hl7.org/CodeSystem/v3-NullFlavor
    CodeDisplayDefinition
    UNK unknown **Description:**A proper value is applicable, but not known.

    **Usage Notes**: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:

    1. Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown')
    2. Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)
    OTH other **Description:**The actual value is not a member of the set of permitted data values in the constrained value domain of a variable. (e.g., concept not provided by required code system).

    **Usage Notes**: This flavor and its specializations are most commonly used with the CD datatype and its flavors. However, it may apply to \*any\* datatype where the constraints of the type are tighter than can be conveyed. For example, a PQ that is for a true measured amount whose units are not supported in UCUM, a need to convey a REAL when the type has been constrained to INT, etc.

    With coded datatypes, this null flavor may only be used if the vocabulary binding has a coding strength of CNE. By definition, all local codes and original text are part of the value set if the coding strength is CWE.

 

Expansion

Generated Narrative: ValueSet

This value set contains 13 concepts

CodeSystemDisplayDefinition
  Ahttp://terminology.hl7.org/CodeSystem/v3-MaritalStatusAnnulled

Marriage contract has been declared null and to not have existed

  Dhttp://terminology.hl7.org/CodeSystem/v3-MaritalStatusDivorced

Marriage contract has been declared dissolved and inactive

  Ihttp://terminology.hl7.org/CodeSystem/v3-MaritalStatusInterlocutory

Subject to an Interlocutory Decree.

  Lhttp://terminology.hl7.org/CodeSystem/v3-MaritalStatusLegally Separated
  Mhttp://terminology.hl7.org/CodeSystem/v3-MaritalStatusMarried

A current marriage contract is active

  Chttp://terminology.hl7.org/CodeSystem/v3-MaritalStatusCommon Law

a marriage recognized in some jurisdictions and based on the parties' agreement to consider themselves married and can also be based on documentation of cohabitation.

This definition was based on https://www.merriam-webster.com/dictionary/common-law%20marriage.

  Phttp://terminology.hl7.org/CodeSystem/v3-MaritalStatusPolygamous

More than 1 current spouse

  Thttp://terminology.hl7.org/CodeSystem/v3-MaritalStatusDomestic partner

Person declares that a domestic partner relationship exists.

  Uhttp://terminology.hl7.org/CodeSystem/v3-MaritalStatusunmarried

Currently not in a marriage contract.

  Shttp://terminology.hl7.org/CodeSystem/v3-MaritalStatusNever Married

No marriage contract has ever been entered

  Whttp://terminology.hl7.org/CodeSystem/v3-MaritalStatusWidowed

The spouse has died

  UNKhttp://terminology.hl7.org/CodeSystem/v3-NullFlavorunknown

**Description:**A proper value is applicable, but not known.

Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:

  1. Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown')
  2. Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)
  OTHhttp://terminology.hl7.org/CodeSystem/v3-NullFlavorother

**Description:**The actual value is not a member of the set of permitted data values in the constrained value domain of a variable. (e.g., concept not provided by required code system).

Usage Notes: This flavor and its specializations are most commonly used with the CD datatype and its flavors. However, it may apply to *any* datatype where the constraints of the type are tighter than can be conveyed. For example, a PQ that is for a true measured amount whose units are not supported in UCUM, a need to convey a REAL when the type has been constrained to INT, etc.

With coded datatypes, this null flavor may only be used if the vocabulary binding has a coding strength of CNE. By definition, all local codes and original text are part of the value set if the coding strength is CWE.

Explanation of the columns that may appear on this page:

Level A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies
System The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code The code (used as the code in the resource instance)
Display The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application
Definition An explanation of the meaning of the concept
Comments Additional notes about how to use the code