VhDir Implementation Guide CI Build: STU2 Ballot

This page is part of the Validated Healthcare Directory FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR v3.5.0. . For a full list of available versions, see the Directory of published versions

Definitions for the StructureDefinition-vhdir-healthcareservice Profile.

HealthcareService
Definition

The details of a healthcare service available at a location.

Control0..*
InvariantsDefined on this element
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
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 (: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.div.exists())
HealthcareService.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

HealthcareService.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1
TypeMeta
HealthcareService.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

HealthcareService.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHOULD be taken from Common Languages
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

HealthcareService.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

HealthcareService.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

HealthcareService.extension
Definition

An Extension

Control0..*
TypeExtension
HealthcareService.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction]])
Definition

Identifies and conveys information about restrictions on the use or release of exchanged information, e.g. information that can only be shared under particular condition, such as a signed data use agreement between parties

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: Reference(VhdirRestriction))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
HealthcareService.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients]])
Definition

An indication of whether a location, service, or practitioner is accepting new patients

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
HealthcareService.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

HealthcareService.identifier
Definition

External identifiers for this item.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
HealthcareService.identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
HealthcareService.identifier.extension
Definition

An Extension

Control0..*
TypeExtension
HealthcareService.identifier.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status]])
Definition

Describes the status of an identifier

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: code)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
HealthcareService.identifier.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
HealthcareService.identifier.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

HealthcareService.identifier.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
HealthcareService.identifier.extension.valueCode(valueCode)
Definition

Describes the status of an identifier

Control1..1
BindingFor example codes, see VhDirIdentifierStatus
Typecode
HealthcareService.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

HealthcareService.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

HealthcareService.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control0..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
HealthcareService.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
HealthcareService.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
HealthcareService.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(VhdirOrganization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

HealthcareService.active
Definition

This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

Control1..1
Typeboolean
Is Modifiertrue
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
HealthcareService.providedBy
Definition

The organization that provides this healthcare service.

Control0..1
TypeReference(VhdirOrganization)
Comments

This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.

HealthcareService.category
Definition

Identifies the broad category of service being performed or delivered.

Control0..*
BindingA category of the service(s) that could be provided.
For example codes, see ServiceCategory
TypeCodeableConcept
Alternate Namesservice category
Comments

Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.

HealthcareService.type
Definition

The specific type of service that may be delivered or performed.

Control0..*
BindingAdditional details about where the content was created (e.g. clinical specialty).
For example codes, see ServiceType
TypeCodeableConcept
Alternate Namesservice type
HealthcareService.specialty
Definition

Collection of specialties handled by the service site. This is more of a medical term.

Control0..*
BindingA specialty that a healthcare service may provide.
The codes SHOULD be taken from PracticeSettingCodeValueSet
TypeCodeableConcept
HealthcareService.location
Definition

The location(s) where this healthcare service may be provided.

Control0..*
TypeReference(VhdirLocation)
HealthcareService.name
Definition

Further description of the service as it would be presented to a consumer while searching.

Control0..1
Typestring
HealthcareService.comment
Definition

Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.

Control0..1
Typestring
Comments

Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.

HealthcareService.extraDetails
Definition

Extra details about the service that can't be placed in the other fields.

Control0..1
Typestring
HealthcareService.photo
Definition

If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.

Control0..1
TypeAttachment
HealthcareService.telecom
Definition

List of contacts related to this specific healthcare service.

Control0..*
TypeContactPoint
Comments

If this is empty, then refer to the location's contacts.

HealthcareService.telecom.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
HealthcareService.telecom.extension
Definition

An Extension

Control0..*
TypeExtension
HealthcareService.telecom.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime]])
Definition

Time period when the contact point is to be used

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
HealthcareService.telecom.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
HealthcareService.telecom.extension.extension
Definition

An Extension

Control0..*
TypeExtension
HealthcareService.telecom.extension.extension(daysOfWeek)
Definition

Days of the week - mon|tue|wed|thu|fri|sat|sun

Control0..*
TypeExtension
HealthcareService.telecom.extension.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
HealthcareService.telecom.extension.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

HealthcareService.telecom.extension.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValuedaysOfWeek
HealthcareService.telecom.extension.extension.valueCode(valueCode)
Definition

Days of the week - mon|tue|wed|thu|fri|sat|sun

Control1..1
BindingThe codes SHALL be taken from DaysOfWeek
Typecode
HealthcareService.telecom.extension.extension(allDay)
Definition

Always available? e.g. 24 hour service

Control0..1
TypeExtension
HealthcareService.telecom.extension.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
HealthcareService.telecom.extension.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

HealthcareService.telecom.extension.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueallDay
HealthcareService.telecom.extension.extension.valueBoolean(valueBoolean)
Definition

Always available? e.g. 24 hour service

Control1..1
Typeboolean
HealthcareService.telecom.extension.extension(availableStartTime)
Definition

Opening time of day (ignored if allDay = true)

Control0..1
TypeExtension
HealthcareService.telecom.extension.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
HealthcareService.telecom.extension.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

HealthcareService.telecom.extension.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueavailableStartTime
HealthcareService.telecom.extension.extension.valueTime(valueTime)
Definition

Opening time of day (ignored if allDay = true)

Control1..1
Typetime
HealthcareService.telecom.extension.extension(availableEndTime)
Definition

Closing time of day (ignored if allDay = true)

Control0..1
TypeExtension
HealthcareService.telecom.extension.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
HealthcareService.telecom.extension.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

HealthcareService.telecom.extension.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueavailableEndTime
HealthcareService.telecom.extension.extension.valueTime(valueTime)
Definition

Closing time of day (ignored if allDay = true)

Control1..1
Typetime
HealthcareService.telecom.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
HealthcareService.telecom.extension.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage
[x] NoteSee Choice of Data Types for further information about how to use [x]
HealthcareService.telecom.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary]])
Definition

Represents an external point of contact responsible for handling communications with this entity

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: Reference(VhdirPractitionerRole | VhdirOrganization | VhdirOrganizationAffiliation | VhdirLocation))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
HealthcareService.telecom.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
HealthcareService.telecom.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

HealthcareService.telecom.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
HealthcareService.telecom.extension.valueReference(valueReference)
Definition

Represents an external point of contact responsible for handling communications with this entity

Control1..1
TypeReference(VhdirPractitionerRole | VhdirOrganization | VhdirOrganizationAffiliation | VhdirLocation)
HealthcareService.telecom.system
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Control1..1 This element is affected by the following invariants: cpt-2
BindingTelecommunications form for contact point.
The codes SHALL be taken from ContactPointSystem
Typecode
HealthcareService.telecom.value
Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Control1..1
Typestring
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

HealthcareService.telecom.use
Definition

Identifies the purpose for the contact point.

Control0..1
BindingUse of contact point.
The codes SHALL be taken from ContactPointUse
Typecode
Is Modifiertrue
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

HealthcareService.telecom.rank
Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Control0..1
TypepositiveInt
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

HealthcareService.telecom.period
Definition

Time period when the contact point was/is in use.

Control0..1
TypePeriod
HealthcareService.coverageArea
Definition

The location(s) that this service is available to (not where the service is provided).

Control0..*
TypeReference(VhdirLocation)
Comments

The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".

HealthcareService.serviceProvisionCode
Definition

The code(s) that detail the conditions under which the healthcare service is available/offered.

Control0..*
BindingThe code(s) that detail the conditions under which the healthcare service is available/offered.
For example codes, see ServiceProvisionConditions
TypeCodeableConcept
Comments

The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply.

HealthcareService.eligibility
Definition

Does this service have specific eligibility requirements that need to be met in order to use the service?

Control0..1
BindingCoded values underwhich a specific service is made available.
TypeCodeableConcept
HealthcareService.eligibilityNote
Definition

Describes the eligibility conditions for the service.

Control0..1
Typestring
Comments

The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.

HealthcareService.programName
Definition

Program Names that can be used to categorize the service.

Control0..*
Typestring
Comments

Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….

HealthcareService.characteristic
Definition

Collection of characteristics (attributes).

Control0..*
BindingA custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
TypeCodeableConcept
Comments

These could be such things as is wheelchair accessible.

HealthcareService.referralMethod
Definition

Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

Control0..*
BindingThe methods of referral can be used when referring to a specific HealthCareService resource.
For example codes, see ReferralMethod
TypeCodeableConcept
HealthcareService.appointmentRequired
Definition

Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

Control0..1
Typeboolean
HealthcareService.availableTime
Definition

A collection of times that the Service Site is available.

Control0..*
TypeBackboneElement
Comments

More detailed availability information may be provided in associated Schedule/Slot resources.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
HealthcareService.availableTime.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
HealthcareService.availableTime.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

HealthcareService.availableTime.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

HealthcareService.availableTime.daysOfWeek
Definition

Indicates which days of the week are available between the start and end Times.

Control0..*
BindingThe days of the week.
The codes SHALL be taken from DaysOfWeek
Typecode
HealthcareService.availableTime.allDay
Definition

Is this always available? (hence times are irrelevant) e.g. 24 hour service.

Control0..1
Typeboolean
HealthcareService.availableTime.availableStartTime
Definition

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

Control0..1
Typetime
Comments

The time zone is expected to be for where this HealthcareService is provided at.

HealthcareService.availableTime.availableEndTime
Definition

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

Control0..1
Typetime
Comments

The time zone is expected to be for where this HealthcareService is provided at.

HealthcareService.notAvailable
Definition

The HealthcareService is not available during this period of time due to the provided reason.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
HealthcareService.notAvailable.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
HealthcareService.notAvailable.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

HealthcareService.notAvailable.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

HealthcareService.notAvailable.description
Definition

The reason that can be presented to the user as to why this time is not available.

Control1..1
Typestring
HealthcareService.notAvailable.during
Definition

Service is not available (seasonally or for a public holiday) from this date.

Control0..1
TypePeriod
HealthcareService.availabilityExceptions
Definition

A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

Control0..1
Typestring
HealthcareService.endpoint
Definition

Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

Control0..*
TypeReference(VhdirEndpoint)
Requirements

Organizations may have different systems covering different services at the different locations and need to be able to define the technical connection details for how to connect to them, and for what purpose.