Release 4 Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Using Codes Code Systems Value Sets Concept Maps Identifier Systems 4.4.1.285 Value Set http://hl7.org/fhir/ValueSet/marital-status

Example Patient/animal (Narrative)

Committee:
Patient Administration Work Group   Maturity Level : N N/A Normative (from v4.0.0) Use Context Standards Status : Any Informative This page has been approved as part of an ANSI standard. See the Compartments : Patient , Practitioner , RelatedPerson Package for further details. This is a value set defined by the FHIR project. Summary Defining URL: http://hl7.org/fhir/ValueSet/marital-status Version: 4.0.1 Name: Marital Status Codes Title: MaritalStatus Definition: This value set defines the set of codes that can be used to indicate the marital status of a person.
    Patient Administration
  • Narrative Work Group OID: 2.16.840.1.113883.4.642.3.29 (for OID based terminology systems) Source Resource
  • XML / JSON This value set is used in the following places: Resource: Patient.maritalStatus (CodeableConcept / Extensible )
    • 4.4.1.285.1 Content Logical Definition This value set includes codes from the following code systems:
  • Include all codes defined in http://terminology.hl7.org/CodeSystem/v3-MaritalStatus JSON
  • Include these codes as defined in http://terminology.hl7.org/CodeSystem/v3-NullFlavor TTL Code Display 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 narrative for a datatype with this property unless: Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown') 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 resource. See also the home phone number that is unknown.)   XML , JSON 4.4.1.285.2 Expansion or Turtle format. This expansion generated 01 Nov 2019 example conforms to the profile Patient .

This value set contains 11 concepts Expansion based on http://terminology.hl7.org/CodeSystem/v3-MaritalStatus version 2018-08-12, http://terminology.hl7.org/CodeSystem/v3-NullFlavor version 2018-08-12 Code System Display

Definition Kenzi female, DoB: 2010-03-23 ( Dog Tag: 1234123 (period: 2010-05-31 --> (ongoing)))

A http://terminology.hl7.org/CodeSystem/v3-MaritalStatus Annulled Marriage contract has been declared null and to not have existed D http://terminology.hl7.org/CodeSystem/v3-MaritalStatus Divorced Marriage contract has been declared dissolved and inactive I http://terminology.hl7.org/CodeSystem/v3-MaritalStatus Interlocutory Subject to an Interlocutory Decree.
L http://terminology.hl7.org/CodeSystem/v3-MaritalStatus Legally Separated Legally Separated M http://terminology.hl7.org/CodeSystem/v3-MaritalStatus Married A current marriage contract is active S http://terminology.hl7.org/CodeSystem/v3-MaritalStatus Never Married No marriage contract has ever been entered U http://terminology.hl7.org/CodeSystem/v3-MaritalStatus unmarried Currently not in a marriage contract.
Active: true
Emergency Contact: P
  • Peter James Chalmers
    • http://terminology.hl7.org/CodeSystem/v3-MaritalStatus
  • ph: (03) 5555 6473(WORK)
    • Polygamous
More than 1 current spouse
Links: T
  • Managing Organization: : Pete's Vetinary Services http://terminology.hl7.org/CodeSystem/v3-MaritalStatus
    • Domestic partner
Person declares that a domestic partner relationship exists.
Patient Animal:
  • species: Dog
  • breed: Golden retriever W
  • genderStatus: Neutered http://terminology.hl7.org/CodeSystem/v3-MaritalStatus
    • Widowed
The spouse has died UNK http://terminology.hl7.org/CodeSystem/v3-NullFlavor 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: Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown') 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.)

 

See the full registry of value sets defined as part of FHIR. Explanation of the columns Other examples that may appear on reference this page: example:

Lvl
  • A few code lists that FHIR defines are hierarchical - each code is assigned a level. For value sets, levels are mostly used to organize codes for user convenience, but may follow code system hierarchy - see Code System List/Long List for further information Source The source of the definition of the code (when the value set draws in codes defined elsewhere)
  • Code RelatedPerson/Peter The code (used as the code in the resource instance). If the code is in italics, this indicates

    •  

    Usage note: every effort has been made to ensure that the code is examples are correct and useful, but they are not selectable ('Abstract') 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 normative part of the concept Comments Additional notes about how to use the code specification.