HL7.FHIR.UV.VHDIR\VhDir Endpoint Usecase

Validated Healthcare Directory
0.2.0 - CI Build

Validated Healthcare Directory, published by HL7 International - Patient Administration Work Group. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7/VhDir/ and changes regularly. See the Directory of published versions

Extension: VhDir Endpoint Usecase

An enumeration of specific use cases (service descriptions) supported by the endpoint

The official URL for this extension is:

http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase

Status: active
Extension maintained by: HL7 International - Patient Administration Work Group

Context of Use

This extension may be used on the following element(s):

Endpoint

An extension to indicate the specific use cases/services supported by an endpoint, e.g. “I support this implementation guide at this endpoint”

Consists of:

useCase.type - an indication of the type of services supported by the endpoint
useCase.standard - a URI to a published standard describing the services supported by the endpoint (e.g. an HL7 implementation guide)

Usage info

Usage:

Use this Extension: VhDir Endpoint
Examples for this Extension: Founding Fathers Memorial Hospital Heart and Vascular Institute Direct address

Formal Views of Extension Content

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

Text Summary
Differential Table
Snapshot Table
All

This structure is derived from Extension

Summary

Mandatory: 2 elements (1 nested mandatory element)
Must-Support: 3 elements
Fixed Value: 3 elements
Prohibited: 1 element

This structure is derived from Extension

Name	Flags	Card.	Type	Description & Constraints
Extension		0..*	Extension	Use case
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:type	S	1..1	Extension	Type
url		1..1	uri	"type"
value[x]:valueCodeableConcept		1..1	CodeableConcept	Type Binding: VhDir Use Case Type (example)
extension:standard	S	0..1	Extension	Standard
url		1..1	uri	"standard"
value[x]:valueUri		1..1	uri	Standard
url		1..1	uri	"http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase"
value[x]	S	0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Extension		0..*	Extension	Use case
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:type	S	1..1	Extension	Type
id		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
id		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
url		1..1	uri	identifies the meaning of the extension
value[x]		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]:valueCodeableConcept		1..1	CodeableConcept	Type Binding: VhDir Use Case Type (example)
extension:standard	S	0..1	Extension	Standard
id		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
id		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
url		1..1	uri	identifies the meaning of the extension
value[x]		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	"standard"
value[x]:valueUri		1..1	uri	Standard
url		1..1	uri	"http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase"
Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 2 elements (1 nested mandatory element)
Must-Support: 3 elements
Fixed Value: 3 elements
Prohibited: 1 element

Differential View

This structure is derived from Extension

Name	Flags	Card.	Type	Description & Constraints
Extension		0..*	Extension	Use case
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:type	S	1..1	Extension	Type
url		1..1	uri	"type"
value[x]:valueCodeableConcept		1..1	CodeableConcept	Type Binding: VhDir Use Case Type (example)
extension:standard	S	0..1	Extension	Standard
url		1..1	uri	"standard"
value[x]:valueUri		1..1	uri	Standard
url		1..1	uri	"http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase"
value[x]	S	0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Extension		0..*	Extension	Use case
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:type	S	1..1	Extension	Type
id		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
id		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
url		1..1	uri	identifies the meaning of the extension
value[x]		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]:valueCodeableConcept		1..1	CodeableConcept	Type Binding: VhDir Use Case Type (example)
extension:standard	S	0..1	Extension	Standard
id		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
id		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
url		1..1	uri	identifies the meaning of the extension
value[x]		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	"standard"
value[x]:valueUri		1..1	uri	Standard
url		1..1	uri	"http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase"
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
Extension.extension:type.value[x]:valueCodeableConcept	example	VhDirUseCaseType

Notes:

No Search criteria for the endpoint-useCase extension.

IG © 2022+ HL7 International - Patient Administration Work Group. Package hl7.fhir.uv.vhdir#0.2.0 based on FHIR 4.0.1. Generated 2022-02-17
Links: Table of Contents | QA Report | Version History | Search | | Propose a change