1.0.0 - release

CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: EncounterPreHospital

Official URL: https://fhir.cambio.se/StructureDefinition/EncounterPreHospital/v1 Version: v1
Active as of 2020-07-01 Computable Name: EncounterPreHospital

Introduction

The EncounterPrehospital profile is created from the FHIR resource Encounter

Intended Use

EncounterPrehospital is used to create an ambulance contact in COSMIC from an external ambulance system when a patient is coming in to the hospital by ambulance.

Lock Functionality

If a certain type of resource is updated, but with the same (or older) lastUpdatedTime, the update will fail. The code which is returned is 200 OK. If the header prefer:return=OperationOutcome is added, a message will be received describing the error.

Specific Rules and Limitations

Type Description
Rule If the patient is changed in the ambulance system, the contact should be invalidated in COSMIC and a new contact is created on the new patient.
Rule The intended users of this API are healthcare professionals.

Statuses

FHIR status Status in COSMIC
In progress Open
Finished Performed
Cancelled Cancelled
Entered in error Invalidated

Versions

COS version Profile version Required COSMIC version Date Description
3.0.0 1.0.0 R8.3.05 June 2020 initial version, support for PUT

Supported Operations

HTTP Method Description
PUT Create an ambulance contact in COSMIC

Search Parameters

N/A

Supported Queries

  1. PUT [baseURL]subscription/Bundle/external-ID

Supported _include params

N/A

Supported _revinclude params

N/A

Error Codes

No specific error codes for EncounterPrehospital. For common codes, refer to Error handling section.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* EncounterEmergency An interaction during which services are provided to the patient
... meta Σ 0..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code in-progress | finished | cancelled | entered-in-error
Binding: EncounterStatus (required): Current state of the encounter.
... class Σ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
.... version Σ 1..1 string Version of the system - if relevant
Fixed Value: 2018-08-12
.... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: EMER
... type Σ 1..1 CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
... subject Σ 1..1 Reference(Patient) The patient or group present at the encounter
... participant Σ 1..1 BackboneElement Ambulance staff
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... individual Σ 1..1 Reference(Practitioner) Persons involved in the encounter other than the patient
... period 1..1 Period The start and end time of the encounter
.... start ΣC 1..1 dateTime Start time of ambulance record
.... end ΣC 0..1 dateTime End time of ambulance record
... location 1..1 BackboneElement Location
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(Location) Location the encounter takes place
..... type Σ 0..1 uri Target resource type
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Location
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... physicalType 0..1 CodeableConcept The physical type of the location
Binding: LocationType (example): Physical form of the location.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classextensibleFixed Value: EMER
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
From the FHIR Standard
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.location.location.typeextensibleFixed Value: Location
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EncounterEmergency

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* EncounterEmergency An interaction during which services are provided to the patient
... meta
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security 0..0
.... tag 0..0
... identifier 1..1 Identifier Identifier(s) by which this encounter is known
... status 1..1 code in-progress | finished | cancelled | entered-in-error
... type 1..1 CodeableConcept Specific type of encounter
.... coding
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 308335008
..... userSelected 0..0
... serviceType 0..0
... priority 0..0
... subject 1..1 Reference(Patient) The patient or group present at the encounter
... episodeOfCare 0..0
... basedOn 0..0
... participant 1..1 BackboneElement Ambulance staff
.... type 0..1 CodeableConcept Role of participant in encounter
.... period 0..0
.... individual 1..1 Reference(Practitioner) Persons involved in the encounter other than the patient
..... identifier
...... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:1.2.752.129.2.1.4.1
...... value 1..1 string The value that is unique
... appointment 0..0
... period 1..1 Period The start and end time of the encounter
.... start 1..1 dateTime Start time of ambulance record
.... end 0..1 dateTime End time of ambulance record
... length 0..0
... reasonCode 0..0
... reasonReference 0..0
... diagnosis 0..0
... account 0..0
... hospitalization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter-destinationArrivalTime 0..1 (Complex) Arrival time at destination
URL: https://fhir.cambio.se/StructureDefinition/EncounterPreHospital/encounter-destinationArrivalTime/v1
...... value[x] 1..1 dateTime Time of arrival
.... destination 0..1 Reference(Location | Organization) Organization to which the patient is discharged
..... identifier
...... system 0..1 uri The namespace for the identifier value
.... dischargeDisposition 0..0
... location 1..1 BackboneElement Location
.... location 1..1 Reference(Location) Location the encounter takes place
..... type 0..1 uri Target resource type
Fixed Value: Location
..... identifier 0..1 Identifier Logical reference, when literal reference is not known
..... display 0..0
.... status 0..0
.... physicalType 0..1 CodeableConcept The physical type of the location
.... period 0..0
... serviceProvider 0..0
... partOf 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* EncounterEmergency An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Identifier(s) by which this encounter is known
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code in-progress | finished | cancelled | entered-in-error
Binding: EncounterStatus (required): Current state of the encounter.
... class Σ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
.... version Σ 1..1 string Version of the system - if relevant
Fixed Value: 2018-08-12
.... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: EMER
.... display Σ 0..1 string Representation defined by the system
... type Σ 1..1 CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: 308335008
..... display Σ 0..1 string Representation defined by the system
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(Patient) The patient or group present at the encounter
... participant Σ 1..1 BackboneElement Ambulance staff
.... 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
.... type Σ 0..1 CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... individual Σ 1..1 Reference(Practitioner) Persons involved in the encounter other than the patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
...... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:1.2.752.129.2.1.4.1
...... value Σ 1..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... display Σ 0..1 string Text alternative for the resource
... period 1..1 Period The start and end time of the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC 1..1 dateTime Start time of ambulance record
.... end ΣC 0..1 dateTime End time of ambulance record
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter-destinationArrivalTime 0..1 (Complex) Arrival time at destination
URL: https://fhir.cambio.se/StructureDefinition/EncounterPreHospital/encounter-destinationArrivalTime/v1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "https://fhir.cambio.se/StructureDefinition/EncounterPreHospital/encounter-destinationArrivalTime/v1"
...... value[x] 1..1 dateTime Time of arrival
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... destination 0..1 Reference(Location | Organization) Organization to which the patient is discharged
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
...... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value Σ 0..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... display Σ 0..1 string Text alternative for the resource
... location 1..1 BackboneElement Location
.... 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
.... location 1..1 Reference(Location) Location the encounter takes place
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Target resource type
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Location
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... physicalType 0..1 CodeableConcept The physical type of the location
Binding: LocationType (example): Physical form of the location.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classextensibleFixed Value: EMER
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
From the FHIR Standard
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.participant.individual.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Encounter.participant.individual.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.participant.individual.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
From the FHIR Standard
Encounter.hospitalization.destination.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Encounter.hospitalization.destination.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.hospitalization.destination.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Encounter.location.location.typeextensibleFixed Value: Location
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EncounterEmergency

Summary

Mandatory: 8 elements(8 nested mandatory elements)
Fixed: 5 elements
Prohibited: 21 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* EncounterEmergency An interaction during which services are provided to the patient
... meta Σ 0..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code in-progress | finished | cancelled | entered-in-error
Binding: EncounterStatus (required): Current state of the encounter.
... class Σ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
.... version Σ 1..1 string Version of the system - if relevant
Fixed Value: 2018-08-12
.... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: EMER
... type Σ 1..1 CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
... subject Σ 1..1 Reference(Patient) The patient or group present at the encounter
... participant Σ 1..1 BackboneElement Ambulance staff
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..1 CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... individual Σ 1..1 Reference(Practitioner) Persons involved in the encounter other than the patient
... period 1..1 Period The start and end time of the encounter
.... start ΣC 1..1 dateTime Start time of ambulance record
.... end ΣC 0..1 dateTime End time of ambulance record
... location 1..1 BackboneElement Location
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... location 1..1 Reference(Location) Location the encounter takes place
..... type Σ 0..1 uri Target resource type
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Location
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... physicalType 0..1 CodeableConcept The physical type of the location
Binding: LocationType (example): Physical form of the location.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classextensibleFixed Value: EMER
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
From the FHIR Standard
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.location.location.typeextensibleFixed Value: Location
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from EncounterEmergency

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* EncounterEmergency An interaction during which services are provided to the patient
... meta
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security 0..0
.... tag 0..0
... identifier 1..1 Identifier Identifier(s) by which this encounter is known
... status 1..1 code in-progress | finished | cancelled | entered-in-error
... type 1..1 CodeableConcept Specific type of encounter
.... coding
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 308335008
..... userSelected 0..0
... serviceType 0..0
... priority 0..0
... subject 1..1 Reference(Patient) The patient or group present at the encounter
... episodeOfCare 0..0
... basedOn 0..0
... participant 1..1 BackboneElement Ambulance staff
.... type 0..1 CodeableConcept Role of participant in encounter
.... period 0..0
.... individual 1..1 Reference(Practitioner) Persons involved in the encounter other than the patient
..... identifier
...... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:1.2.752.129.2.1.4.1
...... value 1..1 string The value that is unique
... appointment 0..0
... period 1..1 Period The start and end time of the encounter
.... start 1..1 dateTime Start time of ambulance record
.... end 0..1 dateTime End time of ambulance record
... length 0..0
... reasonCode 0..0
... reasonReference 0..0
... diagnosis 0..0
... account 0..0
... hospitalization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter-destinationArrivalTime 0..1 (Complex) Arrival time at destination
URL: https://fhir.cambio.se/StructureDefinition/EncounterPreHospital/encounter-destinationArrivalTime/v1
...... value[x] 1..1 dateTime Time of arrival
.... destination 0..1 Reference(Location | Organization) Organization to which the patient is discharged
..... identifier
...... system 0..1 uri The namespace for the identifier value
.... dischargeDisposition 0..0
... location 1..1 BackboneElement Location
.... location 1..1 Reference(Location) Location the encounter takes place
..... type 0..1 uri Target resource type
Fixed Value: Location
..... identifier 0..1 Identifier Logical reference, when literal reference is not known
..... display 0..0
.... status 0..0
.... physicalType 0..1 CodeableConcept The physical type of the location
.... period 0..0
... serviceProvider 0..0
... partOf 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* EncounterEmergency An interaction during which services are provided to the patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Identifier(s) by which this encounter is known
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code in-progress | finished | cancelled | entered-in-error
Binding: EncounterStatus (required): Current state of the encounter.
... class Σ 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
.... version Σ 1..1 string Version of the system - if relevant
Fixed Value: 2018-08-12
.... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: EMER
.... display Σ 0..1 string Representation defined by the system
... type Σ 1..1 CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: 308335008
..... display Σ 0..1 string Representation defined by the system
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(Patient) The patient or group present at the encounter
... participant Σ 1..1 BackboneElement Ambulance staff
.... 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
.... type Σ 0..1 CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
.... individual Σ 1..1 Reference(Practitioner) Persons involved in the encounter other than the patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
...... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:1.2.752.129.2.1.4.1
...... value Σ 1..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... display Σ 0..1 string Text alternative for the resource
... period 1..1 Period The start and end time of the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC 1..1 dateTime Start time of ambulance record
.... end ΣC 0..1 dateTime End time of ambulance record
... hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter-destinationArrivalTime 0..1 (Complex) Arrival time at destination
URL: https://fhir.cambio.se/StructureDefinition/EncounterPreHospital/encounter-destinationArrivalTime/v1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "https://fhir.cambio.se/StructureDefinition/EncounterPreHospital/encounter-destinationArrivalTime/v1"
...... value[x] 1..1 dateTime Time of arrival
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... destination 0..1 Reference(Location | Organization) Organization to which the patient is discharged
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
...... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
...... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value Σ 0..1 string The value that is unique
Example General: 123456
...... period Σ 0..1 Period Time period when id is/was valid for use
...... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
..... display Σ 0..1 string Text alternative for the resource
... location 1..1 BackboneElement Location
.... 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
.... location 1..1 Reference(Location) Location the encounter takes place
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Target resource type
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: Location
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... physicalType 0..1 CodeableConcept The physical type of the location
Binding: LocationType (example): Physical form of the location.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classextensibleFixed Value: EMER
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.typeexampleEncounterType
http://hl7.org/fhir/ValueSet/encounter-type
From the FHIR Standard
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.participant.individual.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Encounter.participant.individual.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.participant.individual.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
From the FHIR Standard
Encounter.hospitalization.destination.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Encounter.hospitalization.destination.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.hospitalization.destination.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Encounter.location.location.typeextensibleFixed Value: Location
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EncounterEmergency

Summary

Mandatory: 8 elements(8 nested mandatory elements)
Fixed: 5 elements
Prohibited: 21 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron