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: MaritalStatusAndEffectiveDateExtension - Detailed Descriptions

Draft as of 2024-09-27

Definitions for the marital-status-and-effective-date extension.

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition
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!
ShortPatient Marital Status and Effective Date
2. Extension.extension
Control2..?
4. Extension.extension:MaritalStatus
Slice NameMaritalStatus
Control1..1
TypeExtension(Patient Marital Status) (Extension Type: CodeableConcept)
InvariantsExtension-MaritalStatusAndEffectiveDateExtension-1: If 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())
6. Extension.extension:MaritalStatusDate
Slice NameMaritalStatusDate
Control1..1
TypeExtension(Patient Marital Status Date) (Extension Type: date)
8. Extension.url
Fixed Valuehttp://jembi.org/fhir/StructureDefinition/marital-status-and-effective-date
10. Extension.value[x]
Control0..0

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition
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!

Optional Extension Element - found in all resources.

ShortPatient Marital Status and Effective DateOptional Extensions Element
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control20..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
    • 4. Extension.extension:MaritalStatus
    Slice NameMaritalStatus
    Definition
    An extension to capture the marital status.

Note: This is for demonstrable purposes only!
    ShortPatient Marital Status
    Control1..1
    TypeExtension(Patient Marital Status) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    Extension-MaritalStatusAndEffectiveDateExtension-1: If 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())
    6. Extension.extension:MaritalStatusDate
    Slice NameMaritalStatusDate
    Definition
    An extension to capture the date for when the marital status came into effect.

Note: This is for demonstrable purposes only!
    ShortPatient Marital Status Date
    Control1..1
    TypeExtension(Patient Marital Status Date) (Extension Type: date)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Extension.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://jembi.org/fhir/StructureDefinition/marital-status-and-effective-date
    10. Extension.value[x]
    Definition

    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortValue of extension
    Control0..01
    TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

    Guidance on how to interpret the contents of this table can be found here

    0. Extension
    Definition
    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!
    ShortPatient Marital Status and Effective Date
    Control0..*
    This element is affected by the following invariants: ele-1
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    2. Extension.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    4. Extension.extension
    Definition

    An Extension

    ShortExtension
    Control2..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
      • 6. Extension.extension:MaritalStatus
      Slice NameMaritalStatus
      Definition
      An extension to capture the marital status.

Note: This is for demonstrable purposes only!
      ShortPatient Marital Status
      Control1..1
      TypeExtension(Patient Marital Status) (Extension Type: CodeableConcept)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      Extension-MaritalStatusAndEffectiveDateExtension-1: If 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())
      8. Extension.extension:MaritalStatusDate
      Slice NameMaritalStatusDate
      Definition
      An extension to capture the date for when the marital status came into effect.

Note: This is for demonstrable purposes only!
      ShortPatient Marital Status Date
      Control1..1
      TypeExtension(Patient Marital Status Date) (Extension Type: date)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      10. Extension.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttp://jembi.org/fhir/StructureDefinition/marital-status-and-effective-date
      12. Extension.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control0..0
      TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))