FHIR Implementation Guide for NJSAMS

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	USCoreEncounterProfile	An interaction during which services are provided to the patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated 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-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
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
modifierExtension	?!N	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
Slices for identifier	SΣ	0..*	Identifier	Identifier(s) by which this encounter is known Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:mClientId	SΣ	0..1	Identifier	Patient identifier for dispensing methadone ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/m-client-id
value	SΣ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
status	?!SΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children
class	SΣ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children
type	SΣ	1..*	CodeableConcept	Specific type of encounter Binding: NJSAMS Client Type (required) ele-1: All FHIR elements must have a @value or children
subject	SΣC	1..1	Reference(US Core Patient Profile)	The patient or group present at the encounter ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
participant	SΣ	0..*	BackboneElement	List of participants involved in the encounter ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	SΣ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children
period	SC	0..1	Period	Period of time during the encounter that the participant participated ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end
individual	SΣC	0..1	Reference(US Core Practitioner Profile)	Persons involved in the encounter other than the patient ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
period	SC	1..1	Period	The start and end time of the encounter ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end
start	ΣC	0..1	dateTime	Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children
reasonCode	SΣ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. ele-1: All FHIR elements must have a @value or children
reasonReference	SΣC	0..1	Reference(US Core Condition Profile)	Reason the encounter takes place (reference) ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
hospitalization	S	0..1	BackboneElement	Details about the admission to a healthcare service ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
admitSource	S	0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: NJSAMS Referral Sources (required) ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:other	S	0..1	(Complex)	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherAdmitSource ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherAdmitSource"
value[x]		0..1	string	Value of extension ele-1: All FHIR elements must have a @value or children
extension:county	S	0..1	(Complex)	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/AdmitCounty ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/AdmitCounty"
value[x]		0..1	Coding	Value of extension Binding: NJSAMS Counties (required) ele-1: All FHIR elements must have a @value or children
dischargeDisposition	S	0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. ele-1: All FHIR elements must have a @value or children
location	S	1..1	BackboneElement	List of locations where the patient has been ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
location	SC	1..1	Reference(Location)	Location the encounter takes place ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
serviceProvider	SC	1..1	Reference(US Core Organization Profile)	The organization (facility) responsible for this encounter ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Encounter.identifier:mClientId.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	required	NJSAMSClientType (a valid code from Encounter Client Type) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-client-type-vs from this IG
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Encounter.hospitalization.admitSource	required	NJSAMSReferralSources (a valid code from Encounter Referral Source) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-referral-sources-vs from this IG
Encounter.hospitalization.admitSource.extension:county.value[x]	required	NJSAMSCounties (a valid code from Patient County) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-counties-vs from this IG
Encounter.hospitalization.dischargeDisposition	example	DischargeDisposition http://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	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	Encounter	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	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	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	Encounter.modifierExtension, Encounter.participant.modifierExtension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.admitSource.extension:other, Encounter.hospitalization.admitSource.extension:county, Encounter.location.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	Encounter.participant.period, Encounter.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Encounter.subject, Encounter.participant.individual, Encounter.reasonReference, Encounter.location.location, Encounter.serviceProvider	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	USCoreEncounterProfile	An interaction during which services are provided to the patient
Slices for identifier		0..*	Identifier	Identifier(s) by which this encounter is known Slice: Unordered, Open by value:system
identifier:mClientId	S	0..1	Identifier	Patient identifier for dispensing methadone
system		1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/m-client-id
value		1..1	string	The value that is unique
status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled +
class		1..1	Coding	Classification of patient encounter
type		1..*	CodeableConcept	Specific type of encounter Binding: NJSAMS Client Type (required)
subject		1..1	Reference(US Core Patient Profile)	The patient or group present at the encounter
period		1..1	Period	The start and end time of the encounter
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
hospitalization
admitSource	S	0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: NJSAMS Referral Sources (required)
Slices for extension				Content/Rules for all slices
extension:other	S	0..1	(Complex)	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherAdmitSource
value[x]		0..1	string	Value of extension
extension:county	S	0..1	(Complex)	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/AdmitCounty
value[x]		0..1	Coding	Value of extension
location		1..1	BackboneElement	List of locations where the patient has been
location		1..1	Reference(Location)	Location the encounter takes place
serviceProvider		1..1	Reference(US Core Organization Profile)	The organization (facility) responsible for this encounter
reference		0..1	string	Literal reference, Relative, internal or absolute URL
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Encounter.type	required	NJSAMSClientType (a valid code from Encounter Client Type) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-client-type-vs from this IG
Encounter.hospitalization.admitSource	required	NJSAMSReferralSources (a valid code from Encounter Referral Source) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-referral-sources-vs from this IG

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	USCoreEncounterProfile	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
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣ	0..*	Identifier	Identifier(s) by which this encounter is known Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension	N	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	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
identifier:mClientId	SΣ	0..1	Identifier	Patient identifier for dispensing methadone
id		0..1	string	Unique id for inter-element referencing
extension	N	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	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/m-client-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
status	?!SΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
statusHistory		0..*	BackboneElement	List of past encounter statuses
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period	C	1..1	Period	The time that the episode was in the specified status per-1: If present, start SHALL have a lower value than end
class	SΣ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter.
classHistory		0..*	BackboneElement	List of past encounter classes
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.
period	C	1..1	Period	The time that the episode was in the specified class per-1: If present, start SHALL have a lower value than end
type	SΣ	1..*	CodeableConcept	Specific type of encounter Binding: NJSAMS Client Type (required)
serviceType	Σ	0..1	CodeableConcept	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject	SΣC	1..1	Reference(US Core Patient Profile)	The patient or group present at the encounter ref-1: SHALL have a contained resource if a local reference is provided
episodeOfCare	ΣC	0..*	Reference(EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against ref-1: SHALL have a contained resource if a local reference is provided
basedOn	C	0..*	Reference(ServiceRequest)	The ServiceRequest that initiated this encounter ref-1: SHALL have a contained resource if a local reference is provided
participant	SΣ	0..*	BackboneElement	List of participants involved in the encounter
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SΣ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period	SC	0..1	Period	Period of time during the encounter that the participant participated per-1: If present, start SHALL have a lower value than end
individual	SΣC	0..1	Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | RelatedPerson)	Persons involved in the encounter other than the patient ref-1: SHALL have a contained resource if a local reference is provided
appointment	ΣC	0..*	Reference(Appointment)	The appointment that scheduled this encounter ref-1: SHALL have a contained resource if a local reference is provided
period	SC	1..1	Period	The start and end time of the encounter per-1: If present, start SHALL have a lower value than end
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
length	C	0..1	Duration	Quantity of time the encounter lasted (less time absent) Binding: CommonUCUMCodesForDuration (extensible): Appropriate units for Duration. Additional Bindings Purpose AllUCUMExpressionForTime Max Binding qty-3: If a code for the unit is present, the system SHALL also be present drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
reasonCode	SΣ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference	SΣC	0..1	Reference(US Core Condition Profile S | US Core Procedure Profile | Observation | ImmunizationRecommendation)	Reason the encounter takes place (reference) ref-1: SHALL have a contained resource if a local reference is provided
diagnosis	Σ	0..*	BackboneElement	The list of diagnosis relevant to this encounter
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
condition	ΣC	1..1	Reference(Condition | Procedure)	The diagnosis or procedure relevant to the encounter ref-1: SHALL have a contained resource if a local reference is provided
use		0..1	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
rank		0..1	positiveInt	Ranking of the diagnosis (for each role type)
account	C	0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter ref-1: SHALL have a contained resource if a local reference is provided
hospitalization	S	0..1	BackboneElement	Details about the admission to a healthcare service
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
origin	C	0..1	Reference(Location | Organization)	The location/organization from which the patient came before admission ref-1: SHALL have a contained resource if a local reference is provided
admitSource	S	0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: NJSAMS Referral Sources (required)
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:other	S	0..1	(Complex)	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherAdmitSource
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherAdmitSource"
value[x]		0..1	string	Value of extension
extension:county	S	0..1	(Complex)	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/AdmitCounty
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/AdmitCounty"
value[x]		0..1	Coding	Value of extension Binding: NJSAMS Counties (required)
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
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: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
destination	C	0..1	Reference(Location | Organization)	Location/organization to which the patient is discharged ref-1: SHALL have a contained resource if a local reference is provided
dischargeDisposition	S	0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
location	S	1..1	BackboneElement	List of locations where the patient has been
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location	SC	1..1	Reference(Location)	Location the encounter takes place ref-1: SHALL have a contained resource if a local reference is provided
status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (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: LocationType (example): Physical form of the location.
period	C	0..1	Period	Time period during which the patient was present at the location per-1: If present, start SHALL have a lower value than end
serviceProvider	SC	1..1	Reference(US Core Organization Profile)	The organization (facility) responsible for this encounter ref-1: SHALL have a contained resource if a local reference is provided
id		0..1	string	Unique id for inter-element referencing
extension	N	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
display	Σ	0..1	string	Text alternative for the resource
partOf	C	0..1	Reference(Encounter)	Another Encounter this encounter is part of ref-1: SHALL have a contained resource if a local reference is provided
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Encounter.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Encounter.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Encounter.identifier:mClientId.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Encounter.identifier:mClientId.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.statusHistory.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	required	NJSAMSClientType (a valid code from Encounter Client Type) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-client-type-vs from this IG
Encounter.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
Encounter.priority	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Encounter.length	extensible	CommonUCUMCodesForDuration http://hl7.org/fhir/ValueSet/duration-units from the FHIR Standard Additional Bindings Purpose AllUCUMExpressionForTime Max Binding
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Encounter.diagnosis.use	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard
Encounter.hospitalization.admitSource	required	NJSAMSReferralSources (a valid code from Encounter Referral Source) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-referral-sources-vs from this IG
Encounter.hospitalization.admitSource.extension:county.value[x]	required	NJSAMSCounties (a valid code from Patient County) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-counties-vs from this IG
Encounter.hospitalization.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreference	example	Diet http://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard
Encounter.hospitalization.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard
Encounter.hospitalization.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard
Encounter.hospitalization.dischargeDisposition	example	DischargeDisposition http://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard
Encounter.location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard
Encounter.serviceProvider.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	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	Encounter	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	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management : text.`div`.exists()
drt-1	error	Encounter.length	There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. : code.exists() implies ((system = %ucum) and value.exists())
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Encounter.extension, Encounter.modifierExtension, Encounter.identifier.extension, Encounter.identifier:mClientId.extension, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.period.extension, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.admitSource.extension, Encounter.hospitalization.admitSource.extension:other, Encounter.hospitalization.admitSource.extension:county, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.serviceProvider.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	Encounter.identifier.period, Encounter.identifier:mClientId.period, Encounter.statusHistory.period, Encounter.classHistory.period, Encounter.participant.period, Encounter.period, Encounter.location.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
qty-3	error	Encounter.length	If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists()
ref-1	error	Encounter.identifier.assigner, Encounter.identifier:mClientId.assigner, Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant.individual, Encounter.appointment, Encounter.reasonReference, Encounter.diagnosis.condition, Encounter.account, Encounter.hospitalization.origin, Encounter.hospitalization.destination, Encounter.location.location, Encounter.serviceProvider, Encounter.partOf	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Extensions

This structure refers to these extensions:

• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherAdmitSource
• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/AdmitCounty

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Encounter.identifier

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	USCoreEncounterProfile	An interaction during which services are provided to the patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated 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-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
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
modifierExtension	?!N	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
Slices for identifier	SΣ	0..*	Identifier	Identifier(s) by which this encounter is known Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:mClientId	SΣ	0..1	Identifier	Patient identifier for dispensing methadone ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/m-client-id
value	SΣ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
status	?!SΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children
class	SΣ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children
type	SΣ	1..*	CodeableConcept	Specific type of encounter Binding: NJSAMS Client Type (required) ele-1: All FHIR elements must have a @value or children
subject	SΣC	1..1	Reference(US Core Patient Profile)	The patient or group present at the encounter ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
participant	SΣ	0..*	BackboneElement	List of participants involved in the encounter ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	SΣ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children
period	SC	0..1	Period	Period of time during the encounter that the participant participated ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end
individual	SΣC	0..1	Reference(US Core Practitioner Profile)	Persons involved in the encounter other than the patient ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
period	SC	1..1	Period	The start and end time of the encounter ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end
start	ΣC	0..1	dateTime	Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children
reasonCode	SΣ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. ele-1: All FHIR elements must have a @value or children
reasonReference	SΣC	0..1	Reference(US Core Condition Profile)	Reason the encounter takes place (reference) ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
hospitalization	S	0..1	BackboneElement	Details about the admission to a healthcare service ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
admitSource	S	0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: NJSAMS Referral Sources (required) ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:other	S	0..1	(Complex)	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherAdmitSource ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherAdmitSource"
value[x]		0..1	string	Value of extension ele-1: All FHIR elements must have a @value or children
extension:county	S	0..1	(Complex)	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/AdmitCounty ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/AdmitCounty"
value[x]		0..1	Coding	Value of extension Binding: NJSAMS Counties (required) ele-1: All FHIR elements must have a @value or children
dischargeDisposition	S	0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. ele-1: All FHIR elements must have a @value or children
location	S	1..1	BackboneElement	List of locations where the patient has been ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
location	SC	1..1	Reference(Location)	Location the encounter takes place ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
serviceProvider	SC	1..1	Reference(US Core Organization Profile)	The organization (facility) responsible for this encounter ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Encounter.identifier:mClientId.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	required	NJSAMSClientType (a valid code from Encounter Client Type) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-client-type-vs from this IG
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Encounter.hospitalization.admitSource	required	NJSAMSReferralSources (a valid code from Encounter Referral Source) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-referral-sources-vs from this IG
Encounter.hospitalization.admitSource.extension:county.value[x]	required	NJSAMSCounties (a valid code from Patient County) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-counties-vs from this IG
Encounter.hospitalization.dischargeDisposition	example	DischargeDisposition http://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	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	Encounter	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	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	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	Encounter.modifierExtension, Encounter.participant.modifierExtension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.admitSource.extension:other, Encounter.hospitalization.admitSource.extension:county, Encounter.location.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	Encounter.participant.period, Encounter.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Encounter.subject, Encounter.participant.individual, Encounter.reasonReference, Encounter.location.location, Encounter.serviceProvider	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	USCoreEncounterProfile	An interaction during which services are provided to the patient
Slices for identifier		0..*	Identifier	Identifier(s) by which this encounter is known Slice: Unordered, Open by value:system
identifier:mClientId	S	0..1	Identifier	Patient identifier for dispensing methadone
system		1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/m-client-id
value		1..1	string	The value that is unique
status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled +
class		1..1	Coding	Classification of patient encounter
type		1..*	CodeableConcept	Specific type of encounter Binding: NJSAMS Client Type (required)
subject		1..1	Reference(US Core Patient Profile)	The patient or group present at the encounter
period		1..1	Period	The start and end time of the encounter
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
hospitalization
admitSource	S	0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: NJSAMS Referral Sources (required)
Slices for extension				Content/Rules for all slices
extension:other	S	0..1	(Complex)	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherAdmitSource
value[x]		0..1	string	Value of extension
extension:county	S	0..1	(Complex)	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/AdmitCounty
value[x]		0..1	Coding	Value of extension
location		1..1	BackboneElement	List of locations where the patient has been
location		1..1	Reference(Location)	Location the encounter takes place
serviceProvider		1..1	Reference(US Core Organization Profile)	The organization (facility) responsible for this encounter
reference		0..1	string	Literal reference, Relative, internal or absolute URL
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Encounter.type	required	NJSAMSClientType (a valid code from Encounter Client Type) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-client-type-vs from this IG
Encounter.hospitalization.admitSource	required	NJSAMSReferralSources (a valid code from Encounter Referral Source) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-referral-sources-vs from this IG

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	USCoreEncounterProfile	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
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣ	0..*	Identifier	Identifier(s) by which this encounter is known Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension	N	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	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
identifier:mClientId	SΣ	0..1	Identifier	Patient identifier for dispensing methadone
id		0..1	string	Unique id for inter-element referencing
extension	N	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	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/m-client-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
status	?!SΣ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
statusHistory		0..*	BackboneElement	List of past encounter statuses
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period	C	1..1	Period	The time that the episode was in the specified status per-1: If present, start SHALL have a lower value than end
class	SΣ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter.
classHistory		0..*	BackboneElement	List of past encounter classes
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.
period	C	1..1	Period	The time that the episode was in the specified class per-1: If present, start SHALL have a lower value than end
type	SΣ	1..*	CodeableConcept	Specific type of encounter Binding: NJSAMS Client Type (required)
serviceType	Σ	0..1	CodeableConcept	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject	SΣC	1..1	Reference(US Core Patient Profile)	The patient or group present at the encounter ref-1: SHALL have a contained resource if a local reference is provided
episodeOfCare	ΣC	0..*	Reference(EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against ref-1: SHALL have a contained resource if a local reference is provided
basedOn	C	0..*	Reference(ServiceRequest)	The ServiceRequest that initiated this encounter ref-1: SHALL have a contained resource if a local reference is provided
participant	SΣ	0..*	BackboneElement	List of participants involved in the encounter
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SΣ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period	SC	0..1	Period	Period of time during the encounter that the participant participated per-1: If present, start SHALL have a lower value than end
individual	SΣC	0..1	Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | RelatedPerson)	Persons involved in the encounter other than the patient ref-1: SHALL have a contained resource if a local reference is provided
appointment	ΣC	0..*	Reference(Appointment)	The appointment that scheduled this encounter ref-1: SHALL have a contained resource if a local reference is provided
period	SC	1..1	Period	The start and end time of the encounter per-1: If present, start SHALL have a lower value than end
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
length	C	0..1	Duration	Quantity of time the encounter lasted (less time absent) Binding: CommonUCUMCodesForDuration (extensible): Appropriate units for Duration. Additional Bindings Purpose AllUCUMExpressionForTime Max Binding qty-3: If a code for the unit is present, the system SHALL also be present drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
reasonCode	SΣ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference	SΣC	0..1	Reference(US Core Condition Profile S | US Core Procedure Profile | Observation | ImmunizationRecommendation)	Reason the encounter takes place (reference) ref-1: SHALL have a contained resource if a local reference is provided
diagnosis	Σ	0..*	BackboneElement	The list of diagnosis relevant to this encounter
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
condition	ΣC	1..1	Reference(Condition | Procedure)	The diagnosis or procedure relevant to the encounter ref-1: SHALL have a contained resource if a local reference is provided
use		0..1	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
rank		0..1	positiveInt	Ranking of the diagnosis (for each role type)
account	C	0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter ref-1: SHALL have a contained resource if a local reference is provided
hospitalization	S	0..1	BackboneElement	Details about the admission to a healthcare service
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
origin	C	0..1	Reference(Location | Organization)	The location/organization from which the patient came before admission ref-1: SHALL have a contained resource if a local reference is provided
admitSource	S	0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: NJSAMS Referral Sources (required)
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:other	S	0..1	(Complex)	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherAdmitSource
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherAdmitSource"
value[x]		0..1	string	Value of extension
extension:county	S	0..1	(Complex)	Extension URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/AdmitCounty
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/AdmitCounty"
value[x]		0..1	Coding	Value of extension Binding: NJSAMS Counties (required)
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
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: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
destination	C	0..1	Reference(Location | Organization)	Location/organization to which the patient is discharged ref-1: SHALL have a contained resource if a local reference is provided
dischargeDisposition	S	0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
location	S	1..1	BackboneElement	List of locations where the patient has been
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location	SC	1..1	Reference(Location)	Location the encounter takes place ref-1: SHALL have a contained resource if a local reference is provided
status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (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: LocationType (example): Physical form of the location.
period	C	0..1	Period	Time period during which the patient was present at the location per-1: If present, start SHALL have a lower value than end
serviceProvider	SC	1..1	Reference(US Core Organization Profile)	The organization (facility) responsible for this encounter ref-1: SHALL have a contained resource if a local reference is provided
id		0..1	string	Unique id for inter-element referencing
extension	N	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
display	Σ	0..1	string	Text alternative for the resource
partOf	C	0..1	Reference(Encounter)	Another Encounter this encounter is part of ref-1: SHALL have a contained resource if a local reference is provided
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Encounter.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Encounter.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Encounter.identifier:mClientId.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Encounter.identifier:mClientId.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.statusHistory.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard
Encounter.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	required	NJSAMSClientType (a valid code from Encounter Client Type) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-client-type-vs from this IG
Encounter.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
Encounter.priority	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Encounter.length	extensible	CommonUCUMCodesForDuration http://hl7.org/fhir/ValueSet/duration-units from the FHIR Standard Additional Bindings Purpose AllUCUMExpressionForTime Max Binding
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Encounter.diagnosis.use	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard
Encounter.hospitalization.admitSource	required	NJSAMSReferralSources (a valid code from Encounter Referral Source) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-referral-sources-vs from this IG
Encounter.hospitalization.admitSource.extension:county.value[x]	required	NJSAMSCounties (a valid code from Patient County) https://fhir.njsams.rutgers.edu/NJSAMS-fhir/ValueSet/njsams-counties-vs from this IG
Encounter.hospitalization.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreference	example	Diet http://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard
Encounter.hospitalization.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard
Encounter.hospitalization.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard
Encounter.hospitalization.dischargeDisposition	example	DischargeDisposition http://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard
Encounter.location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard
Encounter.serviceProvider.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	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	Encounter	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	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management : text.`div`.exists()
drt-1	error	Encounter.length	There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. : code.exists() implies ((system = %ucum) and value.exists())
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Encounter.extension, Encounter.modifierExtension, Encounter.identifier.extension, Encounter.identifier:mClientId.extension, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.period.extension, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.admitSource.extension, Encounter.hospitalization.admitSource.extension:other, Encounter.hospitalization.admitSource.extension:county, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.serviceProvider.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	Encounter.identifier.period, Encounter.identifier:mClientId.period, Encounter.statusHistory.period, Encounter.classHistory.period, Encounter.participant.period, Encounter.period, Encounter.location.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
qty-3	error	Encounter.length	If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists()
ref-1	error	Encounter.identifier.assigner, Encounter.identifier:mClientId.assigner, Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant.individual, Encounter.appointment, Encounter.reasonReference, Encounter.diagnosis.condition, Encounter.account, Encounter.hospitalization.origin, Encounter.hospitalization.destination, Encounter.location.location, Encounter.serviceProvider, Encounter.partOf	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Extensions

This structure refers to these extensions:

• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/OtherAdmitSource
• https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/AdmitCounty

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Encounter.identifier