EHI Export Implementation Guide
0.1.0 - ci-build
EHI Export Implementation Guide
0.1.0 - ci-build
EHI Export Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://ehi-export.pointclickcare.com//StructureDefinition/Census | Version: 0.1.0 | |||
| Draft as of 2025-01-29 | Computable Name: EHICensus | |||
Patient census
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
  Census |
0..* | DomainResource | Census dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||
  meta |
Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children | ||||
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
ele-1: All FHIR elements must have a @value or children | |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |||||
 contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
| identifier |
Σ | 1..1 | Identifier | Identification key | ||||
 subject |
Σ | 1..1 | Reference(Patient) | Patient subject reference | ||||
| effectiveDateTime |
Σ | 0..1 | dateTime | Census effective from this timestamp | ||||
| action |
Σ | 1..1 | string | The census event action type, like Create | ||||
| payer |
Σ | 0..1 | Reference(Location | Organization) | Payer information if available | ||||
| payerOptions |
Σ | 0..1 | string | N - Create new Payer Setup file | Y - Use Last Known Payer Setup file | ||||
| status |
Σ | 0..1 | string | A - Active | HP - Hospital Leave | TP - Therapeutic Leave | ||||
| careLevel |
Σ | 0..1 | string | RUGS code | ||||
| room |
Σ | 0..1 | string | Room where patient is located | ||||
| roomRate |
Σ | 0..1 | string | Rate for the room | ||||
| adtToFromType |
0..1 | Reference(Location | Organization) | Admit Discharge Transfer To From Type | |||||
| adtToFromLocation |
0..1 | string | Admit Discharge Transfer To From Location | |||||
| comments |
0..1 | string | Additional textual comments | |||||
| admissionType |
0..1 | Reference() | Admission type | |||||
| admissionSource |
0..1 | Reference(Location | Organization) | Source of admission | |||||
| dischargeStatus |
0..1 | Reference() | Status of discharge | |||||
| hipps |
0..1 | string | HIPPS value | |||||
| assessmentRefDateTime |
0..1 | dateTime | Assessment Reference Date (ADR) | |||||
 qualifyingHospitalStay |
0..1 | Period | Qualifying Hospital Stay Period | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Census.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Census | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Census | 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 | Census | 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 | Census | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Census | 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() |
This structure is derived from DomainResource
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Census |
0..* | DomainResource | Census | |
| identifier |
Σ | 1..1 | Identifier | Identification key |
| subject |
Σ | 1..1 | Reference(Patient) | Patient subject reference |
| effectiveDateTime |
Σ | 0..1 | dateTime | Census effective from this timestamp |
| action |
Σ | 1..1 | string | The census event action type, like Create |
| payer |
Σ | 0..1 | Reference(Location | Organization) | Payer information if available |
| payerOptions |
Σ | 0..1 | string | N - Create new Payer Setup file | Y - Use Last Known Payer Setup file |
| status |
Σ | 0..1 | string | A - Active | HP - Hospital Leave | TP - Therapeutic Leave |
| careLevel |
Σ | 0..1 | string | RUGS code |
| room |
Σ | 0..1 | string | Room where patient is located |
| roomRate |
Σ | 0..1 | string | Rate for the room |
| adtToFromType |
0..1 | Reference(Location | Organization) | Admit Discharge Transfer To From Type | |
| adtToFromLocation |
0..1 | string | Admit Discharge Transfer To From Location | |
| comments |
0..1 | string | Additional textual comments | |
| admissionType |
0..1 | Reference() | Admission type | |
| admissionSource |
0..1 | Reference(Location | Organization) | Source of admission | |
| dischargeStatus |
0..1 | Reference() | Status of discharge | |
| hipps |
0..1 | string | HIPPS value | |
| assessmentRefDateTime |
0..1 | dateTime | Assessment Reference Date (ADR) | |
| qualifyingHospitalStay |
0..1 | Period | Qualifying Hospital Stay Period | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Census |
0..* | DomainResource | Census | |||||
| 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 |
Σ | 1..1 | Identifier | Identification key | ||||
| subject |
Σ | 1..1 | Reference(Patient) | Patient subject reference | ||||
| effectiveDateTime |
Σ | 0..1 | dateTime | Census effective from this timestamp | ||||
| action |
Σ | 1..1 | string | The census event action type, like Create | ||||
| payer |
Σ | 0..1 | Reference(Location | Organization) | Payer information if available | ||||
| payerOptions |
Σ | 0..1 | string | N - Create new Payer Setup file | Y - Use Last Known Payer Setup file | ||||
| status |
Σ | 0..1 | string | A - Active | HP - Hospital Leave | TP - Therapeutic Leave | ||||
| careLevel |
Σ | 0..1 | string | RUGS code | ||||
| room |
Σ | 0..1 | string | Room where patient is located | ||||
| roomRate |
Σ | 0..1 | string | Rate for the room | ||||
| adtToFromType |
0..1 | Reference(Location | Organization) | Admit Discharge Transfer To From Type | |||||
| adtToFromLocation |
0..1 | string | Admit Discharge Transfer To From Location | |||||
| comments |
0..1 | string | Additional textual comments | |||||
| admissionType |
0..1 | Reference() | Admission type | |||||
| admissionSource |
0..1 | Reference(Location | Organization) | Source of admission | |||||
| dischargeStatus |
0..1 | Reference() | Status of discharge | |||||
| hipps |
0..1 | string | HIPPS value | |||||
| assessmentRefDateTime |
0..1 | dateTime | Assessment Reference Date (ADR) | |||||
| qualifyingHospitalStay |
0..1 | Period | Qualifying Hospital Stay Period | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Census.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Census | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Census | 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 | Census | 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 | Census | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Census | 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() |
This structure is derived from DomainResource
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Census |
0..* | DomainResource | Census dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
ele-1: All FHIR elements must have a @value or children | |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
| identifier |
Σ | 1..1 | Identifier | Identification key | ||||
| subject |
Σ | 1..1 | Reference(Patient) | Patient subject reference | ||||
| effectiveDateTime |
Σ | 0..1 | dateTime | Census effective from this timestamp | ||||
| action |
Σ | 1..1 | string | The census event action type, like Create | ||||
| payer |
Σ | 0..1 | Reference(Location | Organization) | Payer information if available | ||||
| payerOptions |
Σ | 0..1 | string | N - Create new Payer Setup file | Y - Use Last Known Payer Setup file | ||||
| status |
Σ | 0..1 | string | A - Active | HP - Hospital Leave | TP - Therapeutic Leave | ||||
| careLevel |
Σ | 0..1 | string | RUGS code | ||||
| room |
Σ | 0..1 | string | Room where patient is located | ||||
| roomRate |
Σ | 0..1 | string | Rate for the room | ||||
| adtToFromType |
0..1 | Reference(Location | Organization) | Admit Discharge Transfer To From Type | |||||
| adtToFromLocation |
0..1 | string | Admit Discharge Transfer To From Location | |||||
| comments |
0..1 | string | Additional textual comments | |||||
| admissionType |
0..1 | Reference() | Admission type | |||||
| admissionSource |
0..1 | Reference(Location | Organization) | Source of admission | |||||
| dischargeStatus |
0..1 | Reference() | Status of discharge | |||||
| hipps |
0..1 | string | HIPPS value | |||||
| assessmentRefDateTime |
0..1 | dateTime | Assessment Reference Date (ADR) | |||||
| qualifyingHospitalStay |
0..1 | Period | Qualifying Hospital Stay Period | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Census.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Census | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Census | 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 | Census | 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 | Census | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Census | 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() |
Differential View
This structure is derived from DomainResource
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Census |
0..* | DomainResource | Census | |
| identifier |
Σ | 1..1 | Identifier | Identification key |
| subject |
Σ | 1..1 | Reference(Patient) | Patient subject reference |
| effectiveDateTime |
Σ | 0..1 | dateTime | Census effective from this timestamp |
| action |
Σ | 1..1 | string | The census event action type, like Create |
| payer |
Σ | 0..1 | Reference(Location | Organization) | Payer information if available |
| payerOptions |
Σ | 0..1 | string | N - Create new Payer Setup file | Y - Use Last Known Payer Setup file |
| status |
Σ | 0..1 | string | A - Active | HP - Hospital Leave | TP - Therapeutic Leave |
| careLevel |
Σ | 0..1 | string | RUGS code |
| room |
Σ | 0..1 | string | Room where patient is located |
| roomRate |
Σ | 0..1 | string | Rate for the room |
| adtToFromType |
0..1 | Reference(Location | Organization) | Admit Discharge Transfer To From Type | |
| adtToFromLocation |
0..1 | string | Admit Discharge Transfer To From Location | |
| comments |
0..1 | string | Additional textual comments | |
| admissionType |
0..1 | Reference() | Admission type | |
| admissionSource |
0..1 | Reference(Location | Organization) | Source of admission | |
| dischargeStatus |
0..1 | Reference() | Status of discharge | |
| hipps |
0..1 | string | HIPPS value | |
| assessmentRefDateTime |
0..1 | dateTime | Assessment Reference Date (ADR) | |
| qualifyingHospitalStay |
0..1 | Period | Qualifying Hospital Stay Period | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Census |
0..* | DomainResource | Census | |||||
| 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 |
Σ | 1..1 | Identifier | Identification key | ||||
| subject |
Σ | 1..1 | Reference(Patient) | Patient subject reference | ||||
| effectiveDateTime |
Σ | 0..1 | dateTime | Census effective from this timestamp | ||||
| action |
Σ | 1..1 | string | The census event action type, like Create | ||||
| payer |
Σ | 0..1 | Reference(Location | Organization) | Payer information if available | ||||
| payerOptions |
Σ | 0..1 | string | N - Create new Payer Setup file | Y - Use Last Known Payer Setup file | ||||
| status |
Σ | 0..1 | string | A - Active | HP - Hospital Leave | TP - Therapeutic Leave | ||||
| careLevel |
Σ | 0..1 | string | RUGS code | ||||
| room |
Σ | 0..1 | string | Room where patient is located | ||||
| roomRate |
Σ | 0..1 | string | Rate for the room | ||||
| adtToFromType |
0..1 | Reference(Location | Organization) | Admit Discharge Transfer To From Type | |||||
| adtToFromLocation |
0..1 | string | Admit Discharge Transfer To From Location | |||||
| comments |
0..1 | string | Additional textual comments | |||||
| admissionType |
0..1 | Reference() | Admission type | |||||
| admissionSource |
0..1 | Reference(Location | Organization) | Source of admission | |||||
| dischargeStatus |
0..1 | Reference() | Status of discharge | |||||
| hipps |
0..1 | string | HIPPS value | |||||
| assessmentRefDateTime |
0..1 | dateTime | Assessment Reference Date (ADR) | |||||
| qualifyingHospitalStay |
0..1 | Period | Qualifying Hospital Stay Period | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Census.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Census | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Census | 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 | Census | 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 | Census | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Census | 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() |
This structure is derived from DomainResource
Other representations of profile: CSV, Excel, Schematron