abstractbaseDefinitioncopyrightdate- Values Differ
descriptionexperimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisherpurposestatustitletypeurlversion- Values Differ
| Left: | US Public Health Encounter (http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-encounter) |
| Right: | US Public Health Encounter (http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-encounter) |
| Error | StructureDefinition.version | Values for version differ: '2.0.0-snapshot' vs '2.0.0' |
| Information | StructureDefinition.date | Values for date differ: '2025-12-01T09:57:14+03:00' vs '2026-02-16T00:19:11+00:00' |
| Name | Value | Comments | |
|---|---|---|---|
| abstract | false | ||
| baseDefinition | http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter | ||
| copyright | |||
| date | 2025-12-01T09:57:14+03:00 | 2026-02-16T00:19:11+00:00 |
|
| description | This profile represents the encounter related to a public health event. | ||
| experimental | false | ||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
| jurisdiction[0] | urn:iso:std:iso:3166#US | ||
| kind | resource | ||
| name | USPublicHealthEncounter | ||
| publisher | HL7 International / Public Health | ||
| purpose | |||
| status | active | ||
| title | US Public Health Encounter | ||
| type | Encounter | ||
| url | http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-encounter | ||
| version | 2.0.0-snapshot | 2.0.0 |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 Encounter | 0..* | USCoreEncounterProfile | US Public Health Encounter | 0..* | USCoreEncounterProfile | US Public Health Encounter | |||||||||||
 id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
| language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
| 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 | 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 | 0..* | Resource | Contained, inline Resources | |||||||||||
 extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
 identifier | SΣ | 0..* | Identifier | (USCDI+) Encounter Identifier | SΣ | 0..* | Identifier | (USCDI+) Encounter Identifier | |||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 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: ?? (required): Identifies the purpose for this identifier, if known . | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | |||||||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||
| system | SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||||||
| value | SΣ | 1..1 | string | (USCDI) The value that is unique Example General: 123456 | SΣ | 1..1 | string | (USCDI) The value that is unique Example General: 123456 | |||||||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | Σ | 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) | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||||||
| status | ?!SΣ | 1..1 | code | (USCDI+) Encounter Status Binding: ?? (required): Current state of the encounter. | ?!SΣ | 1..1 | code | (USCDI+) Encounter Status Binding: ?? (required): Current state of the encounter. | |||||||||
| statusHistory | 0..* | BackboneElement | List of past encounter statuses | 0..* | BackboneElement | List of past encounter statuses | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: ?? (required): Current state of the encounter. | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: ?? (required): Current state of the encounter. | |||||||||||
| period | 1..1 | Period | The time that the episode was in the specified status | 1..1 | Period | The time that the episode was in the specified status | |||||||||||
| class | SΣ | 1..1 | Coding | (USCDI) Classification of patient encounter Binding: ?? (extensible): Classification of the encounter. | SΣ | 1..1 | Coding | (USCDI) Classification of patient encounter Binding: ?? (extensible): Classification of the encounter. | |||||||||
| classHistory | 0..* | BackboneElement | List of past encounter classes | 0..* | BackboneElement | List of past encounter classes | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ?? (extensible): Classification of the encounter. | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ?? (extensible): Classification of the encounter. | |||||||||||
| period | 1..1 | Period | The time that the episode was in the specified class | 1..1 | Period | The time that the episode was in the specified class | |||||||||||
| type | SΣ | 1..* | CodeableConcept | (USCDI+) Encounter Type Binding: ?? (extensible): Valueset to describe the Encounter Type | SΣ | 1..* | CodeableConcept | (USCDI+) Encounter Type Binding: ?? (extensible): Valueset to describe the Encounter Type | |||||||||
| serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ?? (example): Broad categorization of the service that is to be provided. | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ?? (example): Broad categorization of the service that is to be provided. | |||||||||
| priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ?? (example): Indicates the urgency of the encounter. | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ?? (example): Indicates the urgency of the encounter. | |||||||||||
| subject | SΣ | 1..1 | Reference(US Public Health Patient | US Core Patient Profile) | (USCDI) The patient or group present at the encounter | SΣ | 1..1 | Reference(US Public Health Patient | US Core Patient Profile) | (USCDI) The patient or group present at the encounter | |||||||||
| episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |||||||||
| basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||||||||
| Slices for participant | SΣ | 0..* | BackboneElement | (USCDI) List of participants involved in the encounter Slice: Unordered, Open by type:type | SΣ | 0..* | BackboneElement | (USCDI) List of participants involved in the encounter Slice: Unordered, Open by type:type | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| type | SΣ | 0..* | CodeableConcept | (USCDI) Role of participant in encounter Binding: ?? (extensible): Role of participant in encounter. | SΣ | 0..* | CodeableConcept | (USCDI) Role of participant in encounter Binding: ?? (extensible): Role of participant in encounter. | |||||||||
| period | S | 0..1 | Period | (USCDI) Period of time during the encounter that the participant participated | S | 0..1 | Period | (USCDI) Period of time during the encounter that the participant participated | |||||||||
| individual | SΣ | 0..1 | Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | US Core RelatedPerson Profile) | (USCDI) Persons involved in the encounter other than the patient | SΣ | 0..1 | Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | US Core RelatedPerson Profile) | (USCDI) Persons involved in the encounter other than the patient | |||||||||
| appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | |||||||||
| period | S | 0..1 | Period | (USCDI) The start and end time of the encounter | S | 0..1 | Period | (USCDI) The start and end time of the encounter | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| start | ΣC | 0..1 | dateTime | (USCDI+) Admission Date/Time (Visit Start Date/Time) | ΣC | 0..1 | dateTime | (USCDI+) Admission Date/Time (Visit Start Date/Time) | |||||||||
| end | ΣC | 0..1 | dateTime | Discharge Date/Time (Visit End Date/Time) | ΣC | 0..1 | dateTime | Discharge Date/Time (Visit End Date/Time) | |||||||||
| length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||||||||
| reasonCode | SΣ | 0..* | CodeableConcept | (USCDI+) Reason for the Encounter Binding: ?? (preferred): Reason why the encounter takes place. | SΣ | 0..* | CodeableConcept | (USCDI+) Reason for the Encounter Binding: ?? (preferred): Reason why the encounter takes place. | |||||||||
| Slices for reasonReference | SΣ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile S | US Core Condition Encounter Diagnosis Profile S | US Core Procedure Profile | Observation | ImmunizationRecommendation) | (USCDI+) Reason for the Encounter Slice: Unordered, Open by profile:$this.resolve() | SΣ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile S | US Core Condition Encounter Diagnosis Profile S | US Core Procedure Profile | Observation | ImmunizationRecommendation) | (USCDI+) Reason for the Encounter Slice: Unordered, Open by profile:$this.resolve() | |||||||||
| diagnosis | SΣ | 0..* | BackboneElement | (USCDI+) Encounter Diagnosis, (USCDI+) Chief Complaint (when diagnosis.use='CC') | SΣ | 0..* | BackboneElement | (USCDI+) Encounter Diagnosis, (USCDI+) Chief Complaint (when diagnosis.use='CC') | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| condition | SΣ | 1..1 | Reference(US Public Health Condition Encounter Diagnosis) | The diagnosis or procedure relevant to the encounter | SΣ | 1..1 | Reference(US Public Health Condition Encounter Diagnosis) | The diagnosis or procedure relevant to the encounter | |||||||||
| use | S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: ?? (preferred): The type of diagnosis this condition represents. | S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: ?? (preferred): The type of diagnosis this condition represents. | |||||||||
| rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||||||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||||||||
| hospitalization | S | 0..1 | BackboneElement | (USCDI) Details about the admission to a healthcare service | S | 0..1 | BackboneElement | (USCDI) Details about the admission to a healthcare service | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | 0..1 | Identifier | Pre-admission identifier | |||||||||||
| origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||||||||
| admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: ?? (preferred): From where the patient was admitted. | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: ?? (preferred): From where the patient was admitted. | |||||||||||
| reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: ?? (example): The reason for re-admission of this hospitalization encounter. | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: ?? (example): The reason for re-admission of this hospitalization encounter. | |||||||||||
| dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: ?? (example): Medical, cultural or ethical food preferences to help with catering requirements. | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: ?? (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||||||||
| specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: ?? (preferred): Special courtesies. | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: ?? (preferred): Special courtesies. | |||||||||||
| specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: ?? (preferred): Special arrangements. | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: ?? (preferred): Special arrangements. | |||||||||||
| destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||||||||
| dischargeDisposition | S | 0..1 | CodeableConcept | (USCDI+) Encounter Disposition Binding: ?? (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17 | S | 0..1 | CodeableConcept | (USCDI+) Encounter Disposition Binding: ?? (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17 | |||||||||
| location | S | 1..* | BackboneElement | (USCDI) List of locations where the patient has been | S | 1..* | BackboneElement | (USCDI) List of locations where the patient has been | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| location | S | 1..1 | Reference(US Public Health Location) | (USCDI+) Encounter Location | S | 1..1 | Reference(US Public Health Location) | (USCDI+) Encounter Location | |||||||||
| status | 0..1 | code | planned | active | reserved | completed Binding: ?? (required): The status of the location. | 0..1 | code | planned | active | reserved | completed Binding: ?? (required): The status of the location. | |||||||||||
| physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: ?? (example): Physical form of the location. | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: ?? (example): Physical form of the location. | |||||||||||
| period | 0..1 | Period | Time period during which the patient was present at the location | 0..1 | Period | Time period during which the patient was present at the location | |||||||||||
| serviceProvider | S | 0..1 | Reference(US Public Health Organization) | (USCDI) The organization (facility) responsible for this encounter | S | 0..1 | Reference(US Public Health Organization) | (USCDI) The organization (facility) responsible for this encounter | |||||||||
| partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||||||||
| Documentation for this format | |||||||||||||||||