De-Identified, Anonymized FHIR Profiles Library, published by HL7 International / Cross-Group Projects. 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/fhir-dapl/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-anonymized-patient | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: DAPLAnonymizedPatient | ||
This Patient profile represents an Anonymized Patient
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DAPLDeIdentifiedPatient | DAPL Anonymized Patient | |
![]() ![]() |
SΣ | 0..1 | id | The patient identifier generated by DARTS anonymization service |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
SC | 1..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: us-core-23 |
![]() ![]() ![]() |
S | 1..1 | (Complex) | Indicates the ethnicity of the Patient. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity profiled by http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-ethnicity-extension |
![]() ![]() ![]() |
S | 1..1 | code | Indicates the birth sex of the Patient. URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-birthsex-extension Binding: DAPL Birth Sex Codes (required): The set of codes to be used for UDS+ reporting. |
![]() ![]() ![]() |
S | 1..1 | Quantity, Range | Age of the Patient computed using birthDate and the reporting period reference URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-age-extension |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
?!SΣ | 0..1 | boolean | Can only have deceased boolean. |
![]() ![]() |
SΣ | 1..1 | Address | Included only to support zip code |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Language must be included in the profile Binding: Languages (extensible): The set of languages that the patient uses |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.address.postalCode.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📦4.0.1 | FHIR Std. |
| Patient.communication.language | Base | extensible | Languages | 📦1.0.0 | THO v7.1 |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | 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 | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | 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()
|
| us-core-23 | error | Patient.extension:us-core-race | If "ASKU" or "UNK" are present, then no other OMB race categories can be present. |
extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1
|
This structure is derived from DAPLDeIdentifiedPatient
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DAPLDeIdentifiedPatient | DAPL Anonymized Patient | |
![]() ![]() |
S | 0..1 | id | The patient identifier generated by DARTS anonymization service |
![]() ![]() |
0..0 | Cannot include any text in the resource as part of the deidentified data. | ||
![]() ![]() |
0..0 | Cannot include any contained resources in the resource as part of the deidentified data. | ||
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 1..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
![]() ![]() ![]() |
S | 1..1 | (Complex) | Indicates the ethnicity of the Patient. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity profiled by http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-ethnicity-extension |
![]() ![]() ![]() |
S | 1..1 | code | Indicates the birth sex of the Patient. URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-birthsex-extension Binding: DAPL Birth Sex Codes (required): The set of codes to be used for UDS+ reporting. |
![]() ![]() ![]() |
S | 1..1 | Quantity, Range | Age of the Patient computed using birthDate and the reporting period reference URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-age-extension |
![]() ![]() |
0..0 | Cannot include any identifier in the resource as part of the deidentified data. | ||
![]() ![]() |
0..0 | Cannot include any name in the resource as part of the deidentified data. | ||
![]() ![]() |
0..0 | Cannot include any telecom information in the resource as part of the deidentified data. | ||
![]() ![]() |
0..0 | Cannot include any date of birth information in the resource as part of the deidentified data. | ||
![]() ![]() |
S | 0..1 | boolean | Can only have deceased boolean. |
![]() ![]() |
S | 1..1 | Address | Included only to support zip code |
![]() ![]() ![]() |
0..0 | Text cannot be included in the profile | ||
![]() ![]() ![]() |
0..0 | Street names cannot be included in the profile | ||
![]() ![]() ![]() |
S | 0..0 | ZipCode must be included in the profile | |
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
![]() ![]() |
||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Language must be included in the profile Binding: Languages (extensible): The set of languages that the patient uses |
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.communication.language | Base | extensible | Languages | 📦1.0.0 | THO v7.1 |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DAPLDeIdentifiedPatient | DAPL Anonymized Patient | |||||
![]() ![]() |
SΣ | 0..1 | id | The patient identifier generated by DARTS anonymization service | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SC | 1..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: us-core-23 | ||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | Indicates the ethnicity of the Patient. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity profiled by http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-ethnicity-extension | ||||
![]() ![]() ![]() |
S | 1..1 | code | Indicates the birth sex of the Patient. URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-birthsex-extension Binding: DAPL Birth Sex Codes (required): The set of codes to be used for UDS+ reporting. | ||||
![]() ![]() ![]() |
S | 1..1 | Quantity, Range | Age of the Patient computed using birthDate and the reporting period reference URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-age-extension | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
?!SΣ | 0..1 | boolean | Can only have deceased boolean. | ||||
![]() ![]() |
SΣ | 1..1 | Address | Included only to support zip code | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Language must be included in the profile Binding: Languages (extensible): The set of languages that the patient uses | ||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Patient.address.postalCode.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📦4.0.1 | FHIR Std. |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.0.1 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.communication.language | Base | extensible | Languages | 📦1.0.0 | THO v7.1 |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | 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 | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | 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()
|
| us-core-23 | error | Patient.extension:us-core-race | If "ASKU" or "UNK" are present, then no other OMB race categories can be present. |
extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1
|
This structure is derived from DAPLDeIdentifiedPatient
Summary
Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 11 elements
Prohibited: 16 elements
Extensions
This structure refers to these extensions:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DAPLDeIdentifiedPatient | DAPL Anonymized Patient | |
![]() ![]() |
SΣ | 0..1 | id | The patient identifier generated by DARTS anonymization service |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
SC | 1..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: us-core-23 |
![]() ![]() ![]() |
S | 1..1 | (Complex) | Indicates the ethnicity of the Patient. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity profiled by http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-ethnicity-extension |
![]() ![]() ![]() |
S | 1..1 | code | Indicates the birth sex of the Patient. URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-birthsex-extension Binding: DAPL Birth Sex Codes (required): The set of codes to be used for UDS+ reporting. |
![]() ![]() ![]() |
S | 1..1 | Quantity, Range | Age of the Patient computed using birthDate and the reporting period reference URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-age-extension |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
?!SΣ | 0..1 | boolean | Can only have deceased boolean. |
![]() ![]() |
SΣ | 1..1 | Address | Included only to support zip code |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Language must be included in the profile Binding: Languages (extensible): The set of languages that the patient uses |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.address.postalCode.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📦4.0.1 | FHIR Std. |
| Patient.communication.language | Base | extensible | Languages | 📦1.0.0 | THO v7.1 |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | 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 | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | 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()
|
| us-core-23 | error | Patient.extension:us-core-race | If "ASKU" or "UNK" are present, then no other OMB race categories can be present. |
extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1
|
Differential View
This structure is derived from DAPLDeIdentifiedPatient
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DAPLDeIdentifiedPatient | DAPL Anonymized Patient | |
![]() ![]() |
S | 0..1 | id | The patient identifier generated by DARTS anonymization service |
![]() ![]() |
0..0 | Cannot include any text in the resource as part of the deidentified data. | ||
![]() ![]() |
0..0 | Cannot include any contained resources in the resource as part of the deidentified data. | ||
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 1..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
![]() ![]() ![]() |
S | 1..1 | (Complex) | Indicates the ethnicity of the Patient. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity profiled by http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-ethnicity-extension |
![]() ![]() ![]() |
S | 1..1 | code | Indicates the birth sex of the Patient. URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-birthsex-extension Binding: DAPL Birth Sex Codes (required): The set of codes to be used for UDS+ reporting. |
![]() ![]() ![]() |
S | 1..1 | Quantity, Range | Age of the Patient computed using birthDate and the reporting period reference URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-age-extension |
![]() ![]() |
0..0 | Cannot include any identifier in the resource as part of the deidentified data. | ||
![]() ![]() |
0..0 | Cannot include any name in the resource as part of the deidentified data. | ||
![]() ![]() |
0..0 | Cannot include any telecom information in the resource as part of the deidentified data. | ||
![]() ![]() |
0..0 | Cannot include any date of birth information in the resource as part of the deidentified data. | ||
![]() ![]() |
S | 0..1 | boolean | Can only have deceased boolean. |
![]() ![]() |
S | 1..1 | Address | Included only to support zip code |
![]() ![]() ![]() |
0..0 | Text cannot be included in the profile | ||
![]() ![]() ![]() |
0..0 | Street names cannot be included in the profile | ||
![]() ![]() ![]() |
S | 0..0 | ZipCode must be included in the profile | |
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
![]() ![]() |
||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Language must be included in the profile Binding: Languages (extensible): The set of languages that the patient uses |
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
![]() ![]() |
0..0 | Cannot include information in deidentified resources | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.communication.language | Base | extensible | Languages | 📦1.0.0 | THO v7.1 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DAPLDeIdentifiedPatient | DAPL Anonymized Patient | |||||
![]() ![]() |
SΣ | 0..1 | id | The patient identifier generated by DARTS anonymization service | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SC | 1..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints: us-core-23 | ||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | Indicates the ethnicity of the Patient. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity profiled by http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-ethnicity-extension | ||||
![]() ![]() ![]() |
S | 1..1 | code | Indicates the birth sex of the Patient. URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-birthsex-extension Binding: DAPL Birth Sex Codes (required): The set of codes to be used for UDS+ reporting. | ||||
![]() ![]() ![]() |
S | 1..1 | Quantity, Range | Age of the Patient computed using birthDate and the reporting period reference URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-age-extension | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
?!SΣ | 0..1 | boolean | Can only have deceased boolean. | ||||
![]() ![]() |
SΣ | 1..1 | Address | Included only to support zip code | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Language must be included in the profile Binding: Languages (extensible): The set of languages that the patient uses | ||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Patient.address.postalCode.extension:dataAbsentReason.value[x] | Base | required | DataAbsentReason | 📦4.0.1 | FHIR Std. |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.0.1 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.communication.language | Base | extensible | Languages | 📦1.0.0 | THO v7.1 |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | 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 | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | 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()
|
| us-core-23 | error | Patient.extension:us-core-race | If "ASKU" or "UNK" are present, then no other OMB race categories can be present. |
extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1
|
This structure is derived from DAPLDeIdentifiedPatient
Summary
Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 11 elements
Prohibited: 16 elements
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron