Enhancing FHIR for Social Services, published by SDOH. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/efss/ and changes regularly. See the Directory of published versions
Resource Profile: FHIR Analysis Model for EFSS : Individual
| Official URL: http://hl7.org/fhir/us/StructureDefinition/Individual | Version: 0.1.0 | |||
| Draft as of 2024-03-07 | Computable Name: Individual | |||
A single human being as distinct from a group, class, or family.
Usage:
- Use this Resource: FHIR Analysis Model for EFSS : Membership
- Refer to this Resource: FHIR Analysis Model for EFSS : Association
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DomainResource
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Individual | C | 0..* | DomainResource | FHIR Analysis Model for EFSS : Individual individual-1: Individual.name.given or Individual.name.family or both SHALL be present |
  identifier | Σ | 0..* | Identifier | identifier |
 active | Σ | 1..1 | boolean | active |
| name | Σ | 0..* | HumanName | name |
| telecom | Σ | 0..* | ContactPoint | telecom |
| gender | Σ | 0..1 | code | gender |
| birthDate | Σ | 0..1 | date | birthDate |
| address | Σ | 0..* | Address | address |
| maritalStatus | Σ | 0..1 | CodeableConcept | maritalStatus Binding: Marital or Spousal Status  (required) |
| veteranStatus | Σ | 0..1 | CodeableConcept | veteranStatus Binding: Veteran Status Goals (required) |
 healthStatus | Σ | 0..* | CodeableConcept | healthStatus Binding: Problem (required) |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| Individual.maritalStatus | required | MaritalOrSpousalStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1222.1310 | |
| Individual.veteranStatus | required | VeteranStatusGoals http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1247.214 | |
| Individual.healthStatus | required | Problem http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.7.4 |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| individual-1 | error | Individual | Individual.name.given or Individual.name.family or both SHALL be present : family.exists() or given.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Individual | C | 0..* | DomainResource | FHIR Analysis Model for EFSS : Individual individual-1: Individual.name.given or Individual.name.family or both SHALL be present |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| identifier | Σ | 0..* | Identifier | identifier |
| active | Σ | 1..1 | boolean | active |
| name | Σ | 0..* | HumanName | name |
| telecom | Σ | 0..* | ContactPoint | telecom |
| gender | Σ | 0..1 | code | gender |
| birthDate | Σ | 0..1 | date | birthDate |
| address | Σ | 0..* | Address | address |
| maritalStatus | Σ | 0..1 | CodeableConcept | maritalStatus Binding: Marital or Spousal Status (required) |
| veteranStatus | Σ | 0..1 | CodeableConcept | veteranStatus Binding: Veteran Status Goals (required) |
| healthStatus | Σ | 0..* | CodeableConcept | healthStatus Binding: Problem (required) |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Individual.maritalStatus | required | MaritalOrSpousalStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1222.1310 | |
| Individual.veteranStatus | required | VeteranStatusGoals http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1247.214 | |
| Individual.healthStatus | required | Problem http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.7.4 |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Individual | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Individual | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Individual | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Individual | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Individual | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() | |
| individual-1 | error | Individual | Individual.name.given or Individual.name.family or both SHALL be present : family.exists() or given.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Individual | C | 0..* | DomainResource | FHIR Analysis Model for EFSS : Individual individual-1: Individual.name.given or Individual.name.family or both SHALL be present | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier | Σ | 0..* | Identifier | identifier | ||||
| active | Σ | 1..1 | boolean | active | ||||
| name | Σ | 0..* | HumanName | name | ||||
| telecom | Σ | 0..* | ContactPoint | telecom | ||||
| gender | Σ | 0..1 | code | gender | ||||
| birthDate | Σ | 0..1 | date | birthDate | ||||
| address | Σ | 0..* | Address | address | ||||
| maritalStatus | Σ | 0..1 | CodeableConcept | maritalStatus Binding: Marital or Spousal Status (required) | ||||
| veteranStatus | Σ | 0..1 | CodeableConcept | veteranStatus Binding: Veteran Status Goals (required) | ||||
| healthStatus | Σ | 0..* | CodeableConcept | healthStatus Binding: Problem (required) | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| Individual.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Individual.maritalStatus | required | MaritalOrSpousalStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1222.1310 | ||||
| Individual.veteranStatus | required | VeteranStatusGoals http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1247.214 | ||||
| Individual.healthStatus | required | Problem http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.7.4 |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Individual | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Individual | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Individual | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Individual | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Individual | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() | |
| individual-1 | error | Individual | Individual.name.given or Individual.name.family or both SHALL be present : family.exists() or given.exists() |
This structure is derived from DomainResource
Differential View
This structure is derived from DomainResource
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Individual | C | 0..* | DomainResource | FHIR Analysis Model for EFSS : Individual individual-1: Individual.name.given or Individual.name.family or both SHALL be present |
| identifier | Σ | 0..* | Identifier | identifier |
| active | Σ | 1..1 | boolean | active |
| name | Σ | 0..* | HumanName | name |
| telecom | Σ | 0..* | ContactPoint | telecom |
| gender | Σ | 0..1 | code | gender |
| birthDate | Σ | 0..1 | date | birthDate |
| address | Σ | 0..* | Address | address |
| maritalStatus | Σ | 0..1 | CodeableConcept | maritalStatus Binding: Marital or Spousal Status (required) |
| veteranStatus | Σ | 0..1 | CodeableConcept | veteranStatus Binding: Veteran Status Goals (required) |
| healthStatus | Σ | 0..* | CodeableConcept | healthStatus Binding: Problem (required) |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| Individual.maritalStatus | required | MaritalOrSpousalStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1222.1310 | |
| Individual.veteranStatus | required | VeteranStatusGoals http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1247.214 | |
| Individual.healthStatus | required | Problem http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.7.4 |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| individual-1 | error | Individual | Individual.name.given or Individual.name.family or both SHALL be present : family.exists() or given.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Individual | C | 0..* | DomainResource | FHIR Analysis Model for EFSS : Individual individual-1: Individual.name.given or Individual.name.family or both SHALL be present |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| identifier | Σ | 0..* | Identifier | identifier |
| active | Σ | 1..1 | boolean | active |
| name | Σ | 0..* | HumanName | name |
| telecom | Σ | 0..* | ContactPoint | telecom |
| gender | Σ | 0..1 | code | gender |
| birthDate | Σ | 0..1 | date | birthDate |
| address | Σ | 0..* | Address | address |
| maritalStatus | Σ | 0..1 | CodeableConcept | maritalStatus Binding: Marital or Spousal Status (required) |
| veteranStatus | Σ | 0..1 | CodeableConcept | veteranStatus Binding: Veteran Status Goals (required) |
| healthStatus | Σ | 0..* | CodeableConcept | healthStatus Binding: Problem (required) |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Individual.maritalStatus | required | MaritalOrSpousalStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1222.1310 | |
| Individual.veteranStatus | required | VeteranStatusGoals http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1247.214 | |
| Individual.healthStatus | required | Problem http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.7.4 |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Individual | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Individual | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Individual | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Individual | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Individual | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() | |
| individual-1 | error | Individual | Individual.name.given or Individual.name.family or both SHALL be present : family.exists() or given.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Individual | C | 0..* | DomainResource | FHIR Analysis Model for EFSS : Individual individual-1: Individual.name.given or Individual.name.family or both SHALL be present | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier | Σ | 0..* | Identifier | identifier | ||||
| active | Σ | 1..1 | boolean | active | ||||
| name | Σ | 0..* | HumanName | name | ||||
| telecom | Σ | 0..* | ContactPoint | telecom | ||||
| gender | Σ | 0..1 | code | gender | ||||
| birthDate | Σ | 0..1 | date | birthDate | ||||
| address | Σ | 0..* | Address | address | ||||
| maritalStatus | Σ | 0..1 | CodeableConcept | maritalStatus Binding: Marital or Spousal Status (required) | ||||
| veteranStatus | Σ | 0..1 | CodeableConcept | veteranStatus Binding: Veteran Status Goals (required) | ||||
| healthStatus | Σ | 0..* | CodeableConcept | healthStatus Binding: Problem (required) | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| Individual.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Individual.maritalStatus | required | MaritalOrSpousalStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1222.1310 | ||||
| Individual.veteranStatus | required | VeteranStatusGoals http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1247.214 | ||||
| Individual.healthStatus | required | Problem http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.7.4 |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Individual | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Individual | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Individual | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Individual | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Individual | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() | |
| individual-1 | error | Individual | Individual.name.given or Individual.name.family or both SHALL be present : family.exists() or given.exists() |
This structure is derived from DomainResource
Other representations of profile: CSV, Excel, Schematron