HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1
1.0.0 - ci-build International flag

HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1, published by My Organization. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Gloriamuema/CreateTest-Project/ and changes regularly. See the Directory of published versions

Extension: Patient Marital Status and Effective Date (Experimental)

Official URL: http://example.com/fhir/StructureDefinition/marital-status-and-effective-date Version: 1.0.0
Draft as of 2024-09-27 Computable Name: MaritalStatusAndEffectiveDateExtension 
An extension to capture the marital status and the effective date for when the marital status came into effect.

Note: This is for demonstrable purposes only!

Context of Use

This extension may be used on the following element(s):

  • Element ID RelatedPerson

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Complex Extension: 

An extension to capture the marital status and the effective date for when the marital status came into effect.

Note: This is for demonstrable purposes only!

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension Σ 0..* Extension Patient Marital Status and Effective Date
    ... extension 2..* Extension Extension
    ... Slices for extension Content/Rules for all slices
    .... MaritalStatus C 1..1 CodeableConcept Patient Marital Status
    URL: http://example.com/fhir/StructureDefinition/marital-status
    Binding: MaritalStatusCodes (extensible)
    Additional BindingsPurpose
    Marital Status Required

    Extension-MaritalStatusAndEffectiveDateExtension-1: If valueCodeableConcept.coding.code for the extension "MaritalStatus" is "Other" then the value for CodeableConcept.text SHALL be present.
    .... MaritalStatusDate 1..1 date Patient Marital Status Date
    URL: http://example.com/fhir/StructureDefinition/marital-status-date
    ... url 1..1 uri "http://example.com/fhir/StructureDefinition/marital-status-and-effective-date"

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension Σ 0..* Extension Patient Marital Status and Effective Date
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Extension
    Slice: Unordered, Open by value:url
    .... MaritalStatus C 1..1 CodeableConcept Patient Marital Status
    URL: http://example.com/fhir/StructureDefinition/marital-status
    Binding: MaritalStatusCodes (extensible)
    Additional BindingsPurpose
    Marital Status Required

    Extension-MaritalStatusAndEffectiveDateExtension-1: If valueCodeableConcept.coding.code for the extension "MaritalStatus" is "Other" then the value for CodeableConcept.text SHALL be present.
    .... MaritalStatusDate 1..1 date Patient Marital Status Date
    URL: http://example.com/fhir/StructureDefinition/marital-status-date
    ... url 1..1 uri "http://example.com/fhir/StructureDefinition/marital-status-and-effective-date"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: 

    An extension to capture the marital status and the effective date for when the marital status came into effect.

Note: This is for demonstrable purposes only!

      Differential View

      This structure is derived from Extension

      NameFlagsCard.TypeDescription & Constraintsdoco
      .. Extension Σ 0..* Extension Patient Marital Status and Effective Date
      ... extension 2..* Extension Extension
      ... Slices for extension Content/Rules for all slices
      .... MaritalStatus C 1..1 CodeableConcept Patient Marital Status
      URL: http://example.com/fhir/StructureDefinition/marital-status
      Binding: MaritalStatusCodes (extensible)
      Additional BindingsPurpose
      Marital Status Required

      Extension-MaritalStatusAndEffectiveDateExtension-1: If valueCodeableConcept.coding.code for the extension "MaritalStatus" is "Other" then the value for CodeableConcept.text SHALL be present.
      .... MaritalStatusDate 1..1 date Patient Marital Status Date
      URL: http://example.com/fhir/StructureDefinition/marital-status-date
      ... url 1..1 uri "http://example.com/fhir/StructureDefinition/marital-status-and-effective-date"

      doco Documentation for this format

      Snapshot View

      NameFlagsCard.TypeDescription & Constraintsdoco
      .. Extension Σ 0..* Extension Patient Marital Status and Effective Date
      ... id 0..1 id Unique id for inter-element referencing
      ... Slices for extension 2..* Extension Extension
      Slice: Unordered, Open by value:url
      .... MaritalStatus C 1..1 CodeableConcept Patient Marital Status
      URL: http://example.com/fhir/StructureDefinition/marital-status
      Binding: MaritalStatusCodes (extensible)
      Additional BindingsPurpose
      Marital Status Required

      Extension-MaritalStatusAndEffectiveDateExtension-1: If valueCodeableConcept.coding.code for the extension "MaritalStatus" is "Other" then the value for CodeableConcept.text SHALL be present.
      .... MaritalStatusDate 1..1 date Patient Marital Status Date
      URL: http://example.com/fhir/StructureDefinition/marital-status-date
      ... url 1..1 uri "http://example.com/fhir/StructureDefinition/marital-status-and-effective-date"

      doco Documentation for this format

       

      Other representations of profile: CSV, Excel, Schematron

      Constraints

      IdGradePath(s)DetailsRequirements
      Extension-MaritalStatusAndEffectiveDateExtension-1errorExtension.extension:MaritalStatusIf valueCodeableConcept.coding.code for the extension "MaritalStatus" is "Other" then the value for CodeableConcept.text SHALL be present.
      : value.coding.where(system = 'http://example.com/fhir/CodeSystem/cs-marital-status' and code = 'Other').exists() implies value.text.exists()
      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()