Starter FHIR Implementation Guide
1.0.1 - draft
Starter FHIR Implementation Guide
1.0.1 - draft
Starter FHIR Implementation Guide, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/Starter-FHIR-IG/ and changes regularly. See the Directory of published versions
| Draft as of 2024-11-17 |
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. |
| Short | Patient Marital Status and Effective Date |
| 2. Extension.extension | |
| Control | 2..? |
| 4. Extension.extension:Status | |
| Slice Name | Status |
| Control | 1..1 |
| Type | Extension(Patient Marital Status) (Extension Type: CodeableConcept) |
| Invariants | 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://jembi.org/fhir/CodeSystem/cs-marital-status' and code = 'Other').exists() implies value.text.exists()) |
| 6. Extension.extension:EffectiveDate | |
| Slice Name | EffectiveDate |
| Control | 1..1 |
| Type | Extension(Patient Marital Status Date) (Extension Type: date) |
| 8. Extension.url | |
| Fixed Value | http://jembi.org/fhir/StructureDefinition/marital-status-and-effective-date |
| 10. Extension.value[x] | |
| Control | 0..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. Optional Extension Element - found in all resources. |
| Short | Patient Marital Status and Effective DateOptional Extensions Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-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. |
| Short | ExtensionAdditional 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. |
| Control | 20..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-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()) |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.extension:Status | |
| Slice Name | Status |
| Definition | An extension to capture the marital status. |
| Short | Patient Marital Status |
| Control | 1..1 |
| Type | Extension(Patient Marital Status) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-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://jembi.org/fhir/CodeSystem/cs-marital-status' and code = 'Other').exists() implies value.text.exists()) |
| 6. Extension.extension:EffectiveDate | |
| Slice Name | EffectiveDate |
| Definition | An extension to capture the date for when the marital status came into effect. |
| Short | Patient Marital Status Date |
| Control | 1..1 |
| Type | Extension(Patient Marital Status Date) (Extension Type: date) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-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. |
| Short | identifies 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. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://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). |
| Short | Value of extension |
| Control | 0..01 |
| Type | Choice 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 Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-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. |
| Short | Patient Marital Status and Effective Date |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 4. Extension.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 2..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-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()) |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Extension.extension:Status | |
| Slice Name | Status |
| Definition | An extension to capture the marital status. |
| Short | Patient Marital Status |
| Control | 1..1 |
| Type | Extension(Patient Marital Status) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-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://jembi.org/fhir/CodeSystem/cs-marital-status' and code = 'Other').exists() implies value.text.exists()) |
| 8. Extension.extension:EffectiveDate | |
| Slice Name | EffectiveDate |
| Definition | An extension to capture the date for when the marital status came into effect. |
| Short | Patient Marital Status Date |
| Control | 1..1 |
| Type | Extension(Patient Marital Status Date) (Extension Type: date) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-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. |
| Short | identifies 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. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://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). |
| Short | Value of extension |
| Control | 0..0 |
| Type | Choice 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 Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |