QI-Core Implementation Guide

QI-Core Implementation Guide: STU 4 (v4.0.0 for FHIR 4.0.1)

QI-Core Implementation Guide - This is the current published version.. See the Directory of published versions

D.4.1 StructureDefinition-qicore-encounter-procedure

Introduction:

See the patterns page for implementation and usage patterns.

Examples:

Inpatient Admission for Appendicitis

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter-procedure

Procedures performed during the encounter, or as the primary reason for the encounter.

This profile builds on Extension.

This profile was published on Wed Aug 22 00:00:00 UTC 2018 as a draft by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

Text Summary
Differential Table
Snapshot Table
All

Summary

Mandatory: 3 elements
Fixed Value: 4 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-procedure

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	Encounter Procedure Extension
extension:type	1..1	Extension	type
url	1..1	uri	"type"
value[x]	0..1	CodeableConcept	Binding: QiCoreProcedureType (extensible)
extension:rank	1..1	Extension	rank
url	1..1	uri	"rank"
value[x]	0..1	positiveInt
extension:procedure	1..1	Extension	procedure
url	1..1	uri	"procedure"
value[x]	0..1	Reference(QICoreProcedure)
url	1..1	uri	"http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter-procedure"
value[x]	0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Extension	I	0..*	Extension	Encounter Procedure Extension
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:type	I	1..1	Extension	type
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"type"
value[x]	I	0..1	CodeableConcept	Value of extension Binding: QiCoreProcedureType (extensible)
extension:rank	I	1..1	Extension	rank
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"rank"
value[x]	I	0..1	positiveInt	Value of extension
extension:procedure	I	1..1	Extension	procedure
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"procedure"
value[x]	I	0..1	Reference(QICoreProcedure)	Value of extension
url		1..1	uri	"http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter-procedure"
Documentation for this format

Summary

Mandatory: 3 elements
Fixed Value: 4 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-procedure

Differential View

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	Encounter Procedure Extension
extension:type	1..1	Extension	type
url	1..1	uri	"type"
value[x]	0..1	CodeableConcept	Binding: QiCoreProcedureType (extensible)
extension:rank	1..1	Extension	rank
url	1..1	uri	"rank"
value[x]	0..1	positiveInt
extension:procedure	1..1	Extension	procedure
url	1..1	uri	"procedure"
value[x]	0..1	Reference(QICoreProcedure)
url	1..1	uri	"http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter-procedure"
value[x]	0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Extension	I	0..*	Extension	Encounter Procedure Extension
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:type	I	1..1	Extension	type
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"type"
value[x]	I	0..1	CodeableConcept	Value of extension Binding: QiCoreProcedureType (extensible)
extension:rank	I	1..1	Extension	rank
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"rank"
value[x]	I	0..1	positiveInt	Value of extension
extension:procedure	I	1..1	Extension	procedure
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"procedure"
value[x]	I	0..1	Reference(QICoreProcedure)	Value of extension
url		1..1	uri	"http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter-procedure"
Documentation for this format

D.4.1.2 Terminology Bindings

Terminology Bindings

Path	Conformance	ValueSet
Extension.extension:type.value[x]	extensible	QiCoreProcedureType

D.4.1.3 Constraints

Constraints

Id	Path	Details	Requirements
ele-1	Extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:type	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:type.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:type.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:type.extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:type.extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:type.extension.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:type.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:rank	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:rank	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:rank.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:rank.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:rank.extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:rank.extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:rank.extension.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:rank.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:procedure	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:procedure	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:procedure.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:procedure.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:procedure.extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:procedure.extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:procedure.extension.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:procedure.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())