HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1
1.0.1 - ci-build
HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1
1.0.1 - ci-build
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.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HBosires/Starter-FHIR-IG/ and changes regularly. See the Directory of published versions
| Official URL: http://jembi.org/fhir/StructureDefinition/ExampleLogicalModel | Version: 1.0.1 | |||
| Active as of 2024-09-27 | Computable Name: ExampleLogicalModel | |||
Exchange requirements example.
Note: This is for demonstrable purposes only!
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Element
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ExampleLogicalModel |
0..* | Element | Elements defined in Ancestors:@id, extension ExampleLogicalModel Instances of this logical model are not marked to be the target of a Reference | |
  name |
SΣ | 1..* | BackboneElement | Name |
   firstName |
1..1 | string | First name | |
 middleName |
0..1 | string | Middle name | |
| maritalStatus |
SΣ | 0..1 | BackboneElement | Marital status |
| status |
1..1 | CodeableConcept | Status Binding: Marital Status Codes (extensible) | |
| effectiveDate |
1..1 | date | Effective date | |
 personRelation |
SΣ | 0..* | BackboneElement | Person related to patient |
 name |
1..* | BackboneElement | Name | |
| firstName |
1..1 | string | First name | |
| middleName |
1..1 | string | Middle name | |
| relationshipType |
1..1 | Coding | Relationship type Binding: v3 Code System RoleCode (preferred) | |
| maritalStatus |
SΣ | 0..1 | BackboneElement | Marital status |
| status |
1..1 | CodeableConcept | Status Binding: Marital Status Codes (extensible) | |
| effectiveDate |
1..1 | date | Effective date | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ExampleLogicalModel.maritalStatus.status | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard | |
| ExampleLogicalModel.personRelation.relationshipType | preferred | RoleCodehttp://terminology.hl7.org/ValueSet/v3-RoleCode | |
| ExampleLogicalModel.personRelation.maritalStatus.status | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ExampleLogicalModel |
0..* | Element | Elements defined in Ancestors:@id, extension ExampleLogicalModel Instances of this logical model are not marked to be the target of a Reference | |
| name |
SΣ | 1..* | BackboneElement | Name |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| firstName |
1..1 | string | First name | |
| middleName |
0..1 | string | Middle name | |
| maritalStatus |
SΣ | 0..1 | BackboneElement | Marital status |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status |
1..1 | CodeableConcept | Status Binding: Marital Status Codes (extensible) | |
| effectiveDate |
1..1 | date | Effective date | |
| personRelation |
SΣ | 0..* | BackboneElement | Person related to patient |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
1..* | BackboneElement | Name | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| firstName |
1..1 | string | First name | |
| middleName |
1..1 | string | Middle name | |
| relationshipType |
1..1 | Coding | Relationship type Binding: v3 Code System RoleCode (preferred) | |
| maritalStatus |
SΣ | 0..1 | BackboneElement | Marital status |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status |
1..1 | CodeableConcept | Status Binding: Marital Status Codes (extensible) | |
| effectiveDate |
1..1 | date | Effective date | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ExampleLogicalModel.maritalStatus.status | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard | |
| ExampleLogicalModel.personRelation.relationshipType | preferred | RoleCodehttp://terminology.hl7.org/ValueSet/v3-RoleCode | |
| ExampleLogicalModel.personRelation.maritalStatus.status | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ExampleLogicalModel |
0..* | Element | Elements defined in Ancestors:@id, extension ExampleLogicalModel Instances of this logical model are not marked to be the target of a Reference | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| name |
SΣ | 1..* | BackboneElement | Name |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| firstName |
1..1 | string | First name | |
| middleName |
0..1 | string | Middle name | |
| maritalStatus |
SΣ | 0..1 | BackboneElement | Marital status |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status |
1..1 | CodeableConcept | Status Binding: Marital Status Codes (extensible) | |
| effectiveDate |
1..1 | date | Effective date | |
| personRelation |
SΣ | 0..* | BackboneElement | Person related to patient |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
1..* | BackboneElement | Name | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| firstName |
1..1 | string | First name | |
| middleName |
1..1 | string | Middle name | |
| relationshipType |
1..1 | Coding | Relationship type Binding: v3 Code System RoleCode (preferred) | |
| maritalStatus |
SΣ | 0..1 | BackboneElement | Marital status |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status |
1..1 | CodeableConcept | Status Binding: Marital Status Codes (extensible) | |
| effectiveDate |
1..1 | date | Effective date | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ExampleLogicalModel.maritalStatus.status | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard | |
| ExampleLogicalModel.personRelation.relationshipType | preferred | RoleCodehttp://terminology.hl7.org/ValueSet/v3-RoleCode | |
| ExampleLogicalModel.personRelation.maritalStatus.status | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Element
Differential View
This structure is derived from Element
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ExampleLogicalModel |
0..* | Element | Elements defined in Ancestors:@id, extension ExampleLogicalModel Instances of this logical model are not marked to be the target of a Reference | |
| name |
SΣ | 1..* | BackboneElement | Name |
| firstName |
1..1 | string | First name | |
| middleName |
0..1 | string | Middle name | |
| maritalStatus |
SΣ | 0..1 | BackboneElement | Marital status |
| status |
1..1 | CodeableConcept | Status Binding: Marital Status Codes (extensible) | |
| effectiveDate |
1..1 | date | Effective date | |
| personRelation |
SΣ | 0..* | BackboneElement | Person related to patient |
| name |
1..* | BackboneElement | Name | |
| firstName |
1..1 | string | First name | |
| middleName |
1..1 | string | Middle name | |
| relationshipType |
1..1 | Coding | Relationship type Binding: v3 Code System RoleCode (preferred) | |
| maritalStatus |
SΣ | 0..1 | BackboneElement | Marital status |
| status |
1..1 | CodeableConcept | Status Binding: Marital Status Codes (extensible) | |
| effectiveDate |
1..1 | date | Effective date | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ExampleLogicalModel.maritalStatus.status | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard | |
| ExampleLogicalModel.personRelation.relationshipType | preferred | RoleCodehttp://terminology.hl7.org/ValueSet/v3-RoleCode | |
| ExampleLogicalModel.personRelation.maritalStatus.status | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ExampleLogicalModel |
0..* | Element | Elements defined in Ancestors:@id, extension ExampleLogicalModel Instances of this logical model are not marked to be the target of a Reference | |
| name |
SΣ | 1..* | BackboneElement | Name |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| firstName |
1..1 | string | First name | |
| middleName |
0..1 | string | Middle name | |
| maritalStatus |
SΣ | 0..1 | BackboneElement | Marital status |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status |
1..1 | CodeableConcept | Status Binding: Marital Status Codes (extensible) | |
| effectiveDate |
1..1 | date | Effective date | |
| personRelation |
SΣ | 0..* | BackboneElement | Person related to patient |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
1..* | BackboneElement | Name | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| firstName |
1..1 | string | First name | |
| middleName |
1..1 | string | Middle name | |
| relationshipType |
1..1 | Coding | Relationship type Binding: v3 Code System RoleCode (preferred) | |
| maritalStatus |
SΣ | 0..1 | BackboneElement | Marital status |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status |
1..1 | CodeableConcept | Status Binding: Marital Status Codes (extensible) | |
| effectiveDate |
1..1 | date | Effective date | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ExampleLogicalModel.maritalStatus.status | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard | |
| ExampleLogicalModel.personRelation.relationshipType | preferred | RoleCodehttp://terminology.hl7.org/ValueSet/v3-RoleCode | |
| ExampleLogicalModel.personRelation.maritalStatus.status | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ExampleLogicalModel |
0..* | Element | Elements defined in Ancestors:@id, extension ExampleLogicalModel Instances of this logical model are not marked to be the target of a Reference | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| name |
SΣ | 1..* | BackboneElement | Name |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| firstName |
1..1 | string | First name | |
| middleName |
0..1 | string | Middle name | |
| maritalStatus |
SΣ | 0..1 | BackboneElement | Marital status |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status |
1..1 | CodeableConcept | Status Binding: Marital Status Codes (extensible) | |
| effectiveDate |
1..1 | date | Effective date | |
| personRelation |
SΣ | 0..* | BackboneElement | Person related to patient |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
1..* | BackboneElement | Name | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| firstName |
1..1 | string | First name | |
| middleName |
1..1 | string | Middle name | |
| relationshipType |
1..1 | Coding | Relationship type Binding: v3 Code System RoleCode (preferred) | |
| maritalStatus |
SΣ | 0..1 | BackboneElement | Marital status |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status |
1..1 | CodeableConcept | Status Binding: Marital Status Codes (extensible) | |
| effectiveDate |
1..1 | date | Effective date | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ExampleLogicalModel.maritalStatus.status | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard | |
| ExampleLogicalModel.personRelation.relationshipType | preferred | RoleCodehttp://terminology.hl7.org/ValueSet/v3-RoleCode | |
| ExampleLogicalModel.personRelation.maritalStatus.status | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Element