EHI Export Implementation Guide
0.1.0 - ci-build
EHI Export Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Official URL: https://ehi-export.pointclickcare.com//StructureDefinition/Census | Version: 0.1.0 | |||
Draft as of 2024-02-05 | Computable Name: EHICensus |
Patient census
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DomainResource
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Census | 0..* | DomainResource | Census | |
action | Σ | 1..1 | string | The census event action type, like Create |
admissionSource | 0..1 | Reference(Location | Organization) | Source of admission | |
admissionType | 0..1 | Reference() | Admission type | |
adtToFromLocation | 0..1 | string | Admit Discharge Transfer To From Location | |
adtToFromType | 0..1 | Reference(Location | Organization) | Admit Discharge Transfer To From Type | |
assessmentRefDateTime | 0..1 | dateTime | Assessment Reference Date (ADR) | |
careLevel | Σ | 0..1 | string | RUGS code |
comments | 0..1 | string | Additional textual comments | |
dischargeStatus | 0..1 | Reference() | Status of discharge | |
effectiveDateTime | Σ | 0..1 | dateTime | Census effective from this timestamp |
hipps | 0..1 | string | HIPPS value | |
identifier | Σ | 1..1 | Identifier | Identification key |
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 |
qualifyingHospitalStay | 0..1 | Period | Qualifying Hospital Stay Period | |
room | Σ | 0..1 | string | Room where patient is located |
roomRate | Σ | 0..1 | string | Rate for the room |
status | Σ | 0..1 | string | A - Active | HP - Hospital Leave | TP - Therapeutic Leave |
subject | Σ | 1..1 | Reference(Patient) | Patient subject reference |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Census | 0..* | DomainResource | Census | |
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 |
action | Σ | 1..1 | string | The census event action type, like Create |
admissionSource | 0..1 | Reference(Location | Organization) | Source of admission | |
admissionType | 0..1 | Reference() | Admission type | |
adtToFromLocation | 0..1 | string | Admit Discharge Transfer To From Location | |
adtToFromType | 0..1 | Reference(Location | Organization) | Admit Discharge Transfer To From Type | |
assessmentRefDateTime | 0..1 | dateTime | Assessment Reference Date (ADR) | |
careLevel | Σ | 0..1 | string | RUGS code |
comments | 0..1 | string | Additional textual comments | |
dischargeStatus | 0..1 | Reference() | Status of discharge | |
effectiveDateTime | Σ | 0..1 | dateTime | Census effective from this timestamp |
hipps | 0..1 | string | HIPPS value | |
identifier | Σ | 1..1 | Identifier | Identification key |
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 |
qualifyingHospitalStay | 0..1 | Period | Qualifying Hospital Stay Period | |
room | Σ | 0..1 | string | Room where patient is located |
roomRate | Σ | 0..1 | string | Rate for the room |
status | Σ | 0..1 | string | A - Active | HP - Hospital Leave | TP - Therapeutic Leave |
subject | Σ | 1..1 | Reference(Patient) | Patient subject reference |
Documentation for this format |
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() |
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 | ||||
action | Σ | 1..1 | string | The census event action type, like Create | ||||
admissionSource | 0..1 | Reference(Location | Organization) | Source of admission | |||||
admissionType | 0..1 | Reference() | Admission type | |||||
adtToFromLocation | 0..1 | string | Admit Discharge Transfer To From Location | |||||
adtToFromType | 0..1 | Reference(Location | Organization) | Admit Discharge Transfer To From Type | |||||
assessmentRefDateTime | 0..1 | dateTime | Assessment Reference Date (ADR) | |||||
careLevel | Σ | 0..1 | string | RUGS code | ||||
comments | 0..1 | string | Additional textual comments | |||||
dischargeStatus | 0..1 | Reference() | Status of discharge | |||||
effectiveDateTime | Σ | 0..1 | dateTime | Census effective from this timestamp | ||||
hipps | 0..1 | string | HIPPS value | |||||
identifier | Σ | 1..1 | Identifier | Identification key | ||||
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 | ||||
qualifyingHospitalStay | 0..1 | Period | Qualifying Hospital Stay Period | |||||
room | Σ | 0..1 | string | Room where patient is located | ||||
roomRate | Σ | 0..1 | string | Rate for the room | ||||
status | Σ | 0..1 | string | A - Active | HP - Hospital Leave | TP - Therapeutic Leave | ||||
subject | Σ | 1..1 | Reference(Patient) | Patient subject reference | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Census.language | preferred | CommonLanguages
|
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
Differential View
This structure is derived from DomainResource
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Census | 0..* | DomainResource | Census | |
action | Σ | 1..1 | string | The census event action type, like Create |
admissionSource | 0..1 | Reference(Location | Organization) | Source of admission | |
admissionType | 0..1 | Reference() | Admission type | |
adtToFromLocation | 0..1 | string | Admit Discharge Transfer To From Location | |
adtToFromType | 0..1 | Reference(Location | Organization) | Admit Discharge Transfer To From Type | |
assessmentRefDateTime | 0..1 | dateTime | Assessment Reference Date (ADR) | |
careLevel | Σ | 0..1 | string | RUGS code |
comments | 0..1 | string | Additional textual comments | |
dischargeStatus | 0..1 | Reference() | Status of discharge | |
effectiveDateTime | Σ | 0..1 | dateTime | Census effective from this timestamp |
hipps | 0..1 | string | HIPPS value | |
identifier | Σ | 1..1 | Identifier | Identification key |
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 |
qualifyingHospitalStay | 0..1 | Period | Qualifying Hospital Stay Period | |
room | Σ | 0..1 | string | Room where patient is located |
roomRate | Σ | 0..1 | string | Rate for the room |
status | Σ | 0..1 | string | A - Active | HP - Hospital Leave | TP - Therapeutic Leave |
subject | Σ | 1..1 | Reference(Patient) | Patient subject reference |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Census | 0..* | DomainResource | Census | |
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 |
action | Σ | 1..1 | string | The census event action type, like Create |
admissionSource | 0..1 | Reference(Location | Organization) | Source of admission | |
admissionType | 0..1 | Reference() | Admission type | |
adtToFromLocation | 0..1 | string | Admit Discharge Transfer To From Location | |
adtToFromType | 0..1 | Reference(Location | Organization) | Admit Discharge Transfer To From Type | |
assessmentRefDateTime | 0..1 | dateTime | Assessment Reference Date (ADR) | |
careLevel | Σ | 0..1 | string | RUGS code |
comments | 0..1 | string | Additional textual comments | |
dischargeStatus | 0..1 | Reference() | Status of discharge | |
effectiveDateTime | Σ | 0..1 | dateTime | Census effective from this timestamp |
hipps | 0..1 | string | HIPPS value | |
identifier | Σ | 1..1 | Identifier | Identification key |
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 |
qualifyingHospitalStay | 0..1 | Period | Qualifying Hospital Stay Period | |
room | Σ | 0..1 | string | Room where patient is located |
roomRate | Σ | 0..1 | string | Rate for the room |
status | Σ | 0..1 | string | A - Active | HP - Hospital Leave | TP - Therapeutic Leave |
subject | Σ | 1..1 | Reference(Patient) | Patient subject reference |
Documentation for this format |
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() |
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 | ||||
action | Σ | 1..1 | string | The census event action type, like Create | ||||
admissionSource | 0..1 | Reference(Location | Organization) | Source of admission | |||||
admissionType | 0..1 | Reference() | Admission type | |||||
adtToFromLocation | 0..1 | string | Admit Discharge Transfer To From Location | |||||
adtToFromType | 0..1 | Reference(Location | Organization) | Admit Discharge Transfer To From Type | |||||
assessmentRefDateTime | 0..1 | dateTime | Assessment Reference Date (ADR) | |||||
careLevel | Σ | 0..1 | string | RUGS code | ||||
comments | 0..1 | string | Additional textual comments | |||||
dischargeStatus | 0..1 | Reference() | Status of discharge | |||||
effectiveDateTime | Σ | 0..1 | dateTime | Census effective from this timestamp | ||||
hipps | 0..1 | string | HIPPS value | |||||
identifier | Σ | 1..1 | Identifier | Identification key | ||||
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 | ||||
qualifyingHospitalStay | 0..1 | Period | Qualifying Hospital Stay Period | |||||
room | Σ | 0..1 | string | Room where patient is located | ||||
roomRate | Σ | 0..1 | string | Rate for the room | ||||
status | Σ | 0..1 | string | A - Active | HP - Hospital Leave | TP - Therapeutic Leave | ||||
subject | Σ | 1..1 | Reference(Patient) | Patient subject reference | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Census.language | preferred | CommonLanguages
|
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