Vital Records Death Reporting FHIR Implementation Guide
1.1.0 - STU 2
US
Vital Records Death Reporting FHIR Implementation Guide
1.1.0 - STU 2
US
Vital Records Death Reporting FHIR Implementation Guide - Local Development build (v1.1.0). See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Decedent-Spouse | Version: 1.1.0 | |||
| Draft as of 2020-05-10 | Computable Name: DecedentSpouse | |||
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RelatedPerson
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
  patient | 1..1 | Reference(VRDR Decedent) | patient | |
  relationship | 1..1 | CodeableConcept | relationship Fixed Value: As shown | |
   coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SPS | |
 display | 1..1 | string | Representation defined by the system Fixed Value: spouse | |
 name | 1..1 | HumanName | A name associated with the person | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
 id | Σ | 0..1 | string | Logical id of this artifact |
| 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) Max Binding: AllLanguages: 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 | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | A human identifier for this person |
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
| patient | Σ | 1..1 | Reference(VRDR Decedent) | patient |
| relationship | Σ | 1..1 | CodeableConcept | relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SPS | |
| display | 1..1 | string | Representation defined by the system Fixed Value: spouse | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | 0..0 | string | Plain text representation of the concept | |
| name | Σ | 1..1 | HumanName | A name associated with the person |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the person |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | Σ | 0..1 | date | The date on which the related person was born |
| address | Σ | 0..* | Address | Address where the related person can be contacted or visited |
| photo | 0..* | Attachment | Image of the person | |
| period | 0..1 | Period | Period of time that this relationship is considered valid | |
| communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| preferred | 0..1 | boolean | Language preference indicator | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| Documentation for this format | ||||
This structure is derived from RelatedPerson
Differential View
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| patient | 1..1 | Reference(VRDR Decedent) | patient | |
| relationship | 1..1 | CodeableConcept | relationship Fixed Value: As shown | |
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SPS | |
| display | 1..1 | string | Representation defined by the system Fixed Value: spouse | |
| name | 1..1 | HumanName | A name associated with the person | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| id | Σ | 0..1 | string | Logical id of this artifact |
| 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) Max Binding: AllLanguages: 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 | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | A human identifier for this person |
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
| patient | Σ | 1..1 | Reference(VRDR Decedent) | patient |
| relationship | Σ | 1..1 | CodeableConcept | relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. Fixed Value: As shown |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SPS | |
| display | 1..1 | string | Representation defined by the system Fixed Value: spouse | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | 0..0 | string | Plain text representation of the concept | |
| name | Σ | 1..1 | HumanName | A name associated with the person |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the person |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | Σ | 0..1 | date | The date on which the related person was born |
| address | Σ | 0..* | Address | Address where the related person can be contacted or visited |
| photo | 0..* | Attachment | Image of the person | |
| period | 0..1 | Period | Period of time that this relationship is considered valid | |
| communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| preferred | 0..1 | boolean | Language preference indicator | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| RelatedPerson.language | preferred | CommonLanguages Max Binding: AllLanguages |
| RelatedPerson.relationship | preferred | Fixed Value: SPS("spouse") |
| RelatedPerson.gender | required | AdministrativeGender |
| RelatedPerson.communication.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Id | Grade | Path | Details | Requirements |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | 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 | RelatedPerson | 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 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Best Practice | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | RelatedPerson.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | RelatedPerson.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | RelatedPerson.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | RelatedPerson.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | RelatedPerson.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | RelatedPerson.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | RelatedPerson.communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | RelatedPerson.communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | RelatedPerson.communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | RelatedPerson.communication.preferred | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2021+ Health Level Seven International. Package hl7.fhir.us.vrdr#1.1.0 based on FHIR 4.0.1. Generated 2022-04-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change