Page Status: draft updated 2025-08-08

Ändringslogg

ID Datum Kommentar
2 2025-03-03 Felkod tillagd per-1
1 2025-03-03 Severity error och regex tillagd hvo-time-1

HealthcareService - HVOBusiness

Informationsmodell_2025-05-07_organisation Information domain hvo-organization-business, where this resource is represented as Verksamhet

Page index

General information

See HL7 HealthcareService for general information about the resource.

Scope and Usage

The HealthcareService resource as it is profiled in HVOBusiness holds information about work that is continuously performed within a certain field (sv: verksamhet).

Boundaries and Relationships

This resource is contained in HVOOrganizationalUnit, hence it cannot be accessed directly. See References for more information about how to access contained resources.

A HVOOrganizationalUnit can only contain one HVOBusiness. To express that an organizational unit contains multiple businesses, use HVOBusiness.category which takes an array of codes.

Profile

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
identifierΣ0..*Identifier
activeΣ ?!0..1boolean
providedByS Σ1..1Reference(HVOOrganizationalUnit)
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
typeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
locationS Σ0..*Reference(HVOLocation)
nameΣ0..1string
commentΣ0..1string
extraDetails0..1markdown
photoΣ0..1Attachment
telecom0..*ContactPoint
coverageArea0..*Reference(Location)
serviceProvisionCode0..*CodeableConcept
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
code0..1CodeableConcept
comment0..1markdown
program0..*CodeableConcept
characteristic0..*CodeableConcept
communication0..*CodeableConceptBinding
referralMethod0..*CodeableConcept
appointmentRequired0..1boolean
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
daysOfWeekS0..*codeBinding
allDayS0..1boolean
availableStartTimeS0..1time
availableEndTimeS0..1time
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
descriptionS1..1string
id0..1string
extensionC0..*Extension
startS Σ C1..1dateTime
endS Σ C0..1dateTime
availabilityExceptions0..1string
endpoint0..*Reference(Endpoint)
HealthcareService
ShortThe details of a healthcare service available at a location
Definition

The details of a healthcare service available at a location.

Cardinality0..*
Constraints
  • 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()
Mappings
  • rim: Entity. Role, or Act
  • rim: act[classCode=ACT][moodCode=DEF]
HealthcareService.id
ShortLogical id of this artifact
Definition

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

Cardinality0..1
Typestring
SummaryTrue
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
ShortMetadata about the resource
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.

Cardinality0..1
TypeMeta
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
HealthcareService.implicitRules
ShortA set of rules under which this content was created
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.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
HealthcareService.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
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).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
HealthcareService.text
ShortText summary of the resource, for human interpretation
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.

Cardinality0..1
TypeNarrative
Aliasnarrative, 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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
HealthcareService.contained
ShortContained, inline Resources
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.

Cardinality0..*
TypeResource
Aliasinline 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.

Mappings
  • rim: N/A
HealthcareService.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the resource. 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Constraints
  • 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()
Mappings
  • rim: N/A
HealthcareService.modifierExtension
ShortExtensions that cannot be ignored
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 and/or the understanding of the containing element's descendants. 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).

Cardinality0..*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Constraints
  • 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()
Mappings
  • rim: N/A
HealthcareService.identifier
ShortExternal identifiers for this item
Definition

External identifiers for this item.

Cardinality0..*
TypeIdentifier
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • rim: .id
HealthcareService.active
ShortWhether this HealthcareService record is in active use
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.

Cardinality0..1
Typeboolean
ModifierTrue
SummaryTrue
Comments

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

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: .statusCode
HealthcareService.providedBy
ShortOrganization that provides this service
Definition

The organization that provides this healthcare service.

Cardinality1..1
TypeReference(HVOOrganizationalUnit)
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .scopingRole.Organization
  • HVOBusinessToHVOVerksamhetLogical: bedriver(HVOOrganisatoriskEnhetLogical)
HealthcareService.category
ShortWhat type of goal oriented work is being done, e.g. logopedics.
Definition

Identifies the broad category of service being performed or delivered.

Cardinality0..*
TypeCodeableConcept
Binding

A category of the service(s) that could be provided.

ServiceCategory (example)

Must SupportTrue
SummaryTrue
Aliasservice category
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • rim: .code
  • HVOBusinessToHVOVerksamhetLogical: typ
HealthcareService.category.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
HealthcareService.category.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • 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()
Mappings
  • rim: n/a
HealthcareService.category.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality1..1
TypeCoding
Must SupportTrue
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Slicing

Unordered, Open, by system(Value)

Slice on CodeableConcept.coding based on the system value

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
HealthcareService.category.coding:HVOBusinessType
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..1
TypeCoding
Binding

hvo-business-category (required)

Must SupportTrue
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
HealthcareService.category.coding:HVOBusinessType.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
HealthcareService.category.coding:HVOBusinessType.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • 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()
Mappings
  • rim: n/a
HealthcareService.category.coding:HVOBusinessType.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
HealthcareService.category.coding:HVOBusinessType.version
ShortVersion of the system - if relevant
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Cardinality0..1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
HealthcareService.category.coding:HVOBusinessType.code
ShortSymbol in syntax defined by the system
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality1..1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
HealthcareService.category.coding:HVOBusinessType.display
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
HealthcareService.category.coding:HVOBusinessType.userSelected
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
HealthcareService.category.coding:HSABusinessType
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..1
TypeCoding
Binding

hvo-business-category-inera (required)

Must SupportTrue
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
HealthcareService.category.coding:HSABusinessType.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
HealthcareService.category.coding:HSABusinessType.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • 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()
Mappings
  • rim: n/a
HealthcareService.category.coding:HSABusinessType.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
HealthcareService.category.coding:HSABusinessType.version
ShortVersion of the system - if relevant
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Cardinality0..1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
HealthcareService.category.coding:HSABusinessType.code
ShortSymbol in syntax defined by the system
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality1..1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
HealthcareService.category.coding:HSABusinessType.display
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
HealthcareService.category.coding:HSABusinessType.userSelected
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
HealthcareService.category.text
ShortPlain text representation of the concept
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality0..1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
HealthcareService.type
ShortType of service that may be delivered or performed
Definition

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

Cardinality0..*
TypeCodeableConcept
Binding

Additional details about where the content was created (e.g. clinical specialty).

ServiceType (example)

SummaryTrue
Aliasservice type
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code
HealthcareService.specialty
ShortSpecialties handled by the HealthcareService
Definition

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

Cardinality0..*
TypeCodeableConcept
Binding

A specialty that a healthcare service may provide.

PracticeSettingCodeValueSet (preferred)

SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code
HealthcareService.location
ShortLocation(s) where service may be provided
Definition

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

Cardinality0..*
TypeReference(HVOLocation)
Must SupportTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.where[x]
  • rim: .location.role[classCode=SDLOC]
  • HVOBusinessToHVOVerksamhetLogical: bedrivsPa(HVOPlatsLogical)
HealthcareService.name
ShortDescription of service as presented to a consumer while searching
Definition

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

Cardinality0..1
Typestring
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .name
HealthcareService.comment
ShortAdditional description and/or any specific issues not covered elsewhere
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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .location.role[classCode=SDLOC].desc
HealthcareService.extraDetails
ShortExtra details about the service that can't be placed in the other fields
Definition

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

Cardinality0..1
Typemarkdown
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].text
HealthcareService.photo
ShortFacilitates quick identification of the service
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.

Cardinality0..1
TypeAttachment
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=SBJ].observation.value
HealthcareService.telecom
ShortContacts related to the healthcare service
Definition

List of contacts related to this specific healthcare service.

Cardinality0..*
TypeContactPoint
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .telecom
HealthcareService.coverageArea
ShortLocation(s) service is intended for/available to
Definition

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

Cardinality0..*
TypeReference(Location)
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".

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate
HealthcareService.serviceProvisionCode
ShortConditions under which service is available/offered
Definition

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

Cardinality0..*
TypeCodeableConcept
Binding

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

ServiceProvisionConditions (example)

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]
HealthcareService.eligibility
ShortSpecific eligibility requirements required to use the service
Definition

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

Cardinality0..*
TypeBackboneElement
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
HealthcareService.eligibility.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
HealthcareService.eligibility.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Constraints
  • 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()
Mappings
  • rim: n/a
HealthcareService.eligibility.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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 and/or the understanding of the containing element's descendants. 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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Constraints
  • 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()
Mappings
  • rim: N/A
HealthcareService.eligibility.code
ShortCoded value for the eligibility
Definition

Coded value for the eligibility.

Cardinality0..1
TypeCodeableConcept
Binding

Coded values underwhich a specific service is made available.

(unbound) (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]
HealthcareService.eligibility.comment
ShortDescribes the eligibility conditions for the service
Definition

Describes the eligibility conditions for the service.

Cardinality0..1
Typemarkdown
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text
HealthcareService.program
ShortPrograms that this service is applicable to
Definition

Programs that this service is applicable to.

Cardinality0..*
TypeCodeableConcept
Binding

Government or local programs that this service applies to.

Program (example)

Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PERT].observation
HealthcareService.characteristic
ShortCollection of characteristics (attributes)
Definition

Collection of characteristics (attributes).

Cardinality0..*
TypeCodeableConcept
Binding

A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).

(unbound) (example)

Comments

These could be such things as is wheelchair accessible.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PERT].observation
HealthcareService.communication
ShortThe language that this service is offered in
Definition

Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

Cardinality0..*
TypeCodeableConcept
Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Comments

When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
HealthcareService.referralMethod
ShortWays that the service accepts referrals
Definition

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

Cardinality0..*
TypeCodeableConcept
Binding

The methods of referral can be used when referring to a specific HealthCareService resource.

ReferralMethod (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PERT].observation
HealthcareService.appointmentRequired
ShortIf an appointment is required for access to this service
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.

Cardinality0..1
Typeboolean
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .actrelationship[typeCode=PERT].observation
HealthcareService.availableTime
ShortTimes the Service Site is available
Definition

A collection of times that the Service Site is available.

Cardinality0..*
TypeBackboneElement
Must SupportTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
  • HVOBusinessToHVOVerksamhetLogical: harOppetUnder(HVOTillganglighetstidLogical)
HealthcareService.availableTime.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
HealthcareService.availableTime.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Constraints
  • 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()
Mappings
  • rim: n/a
HealthcareService.availableTime.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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 and/or the understanding of the containing element's descendants. 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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Constraints
  • 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()
Mappings
  • rim: N/A
HealthcareService.availableTime.daysOfWeek
Shortmon | tue | wed | thu | fri | sat | sun
Definition

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

Cardinality0..*
Typecode
Binding

The days of the week.

DaysOfWeek (required)

Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
HealthcareService.availableTime.allDay
ShortAlways available? e.g. 24 hour service
Definition

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

Cardinality0..1
Typeboolean
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
HealthcareService.availableTime.availableStartTime
ShortOpening time of day (ignored if allDay = true)
Definition

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

Cardinality0..1
Typetime
Must SupportTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
HealthcareService.availableTime.availableEndTime
ShortClosing time of day (ignored if allDay = true)
Definition

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

Cardinality0..1
Typetime
Must SupportTrue
Comments

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
HealthcareService.notAvailable
ShortNot available during this time due to provided reason
Definition

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

Cardinality0..*
TypeBackboneElement
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
  • HVOBusinessToHVOVerksamhetLogical: harTillganglighetsavvikelse(HVOStorningsinformationLogical)
HealthcareService.notAvailable.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
HealthcareService.notAvailable.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Constraints
  • 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()
Mappings
  • rim: n/a
HealthcareService.notAvailable.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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 and/or the understanding of the containing element's descendants. 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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Constraints
  • 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()
Mappings
  • rim: N/A
HealthcareService.notAvailable.description
ShortReason presented to the user explaining why time not available
Definition

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

Cardinality1..1
Typestring
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
HealthcareService.notAvailable.during
ShortService not available from this date
Definition

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

Cardinality1..1
TypePeriod
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
HealthcareService.notAvailable.during.id
ShortUnique id for inter-element referencing
Definition

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

Cardinality0..1
Typestring
Mappings
  • rim: n/a
HealthcareService.notAvailable.during.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • 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()
Mappings
  • rim: n/a
HealthcareService.notAvailable.during.start
ShortStarting time with inclusive boundary
Definition

The start of the period. The boundary is inclusive.

Cardinality1..1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

If the low element is missing, the meaning is that the low boundary is not known.

ConditionsThe cardinality or value of this element may be affected by these constraints: per-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.1
  • rim: ./low
HealthcareService.notAvailable.during.end
ShortEnd time with inclusive boundary, if not ongoing
Definition

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Cardinality0..1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

ConditionsThe cardinality or value of this element may be affected by these constraints: per-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.2
  • rim: ./high
HealthcareService.availabilityExceptions
ShortDescription of availability exceptions
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.

Cardinality0..1
Typestring
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
HealthcareService.endpoint
ShortTechnical endpoints providing access to electronic services operated for the healthcare service
Definition

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

Cardinality0..*
TypeReference(Endpoint)
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="HVOBusiness" />
<url value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOBusiness" />
<version value="0.1.0" />
<name value="HVOBusiness" />
<status value="draft" />
<description value="HVOBusiness contains information about work which is conducted within a line of work" />
<fhirVersion value="4.0.1" />
<identity value="HVOBusinessToHVOVerksamhetLogical" />
<uri value="HVOVerksamhetLogical" />
</mapping>
<kind value="resource" />
<abstract value="false" />
<type value="HealthcareService" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/HealthcareService" />
<derivation value="constraint" />
<element id="HealthcareService.providedBy">
<path value="HealthcareService.providedBy" />
<min value="1" />
<code value="Reference" />
<targetProfile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" />
</type>
<mustSupport value="true" />
<identity value="HVOBusinessToHVOVerksamhetLogical" />
<map value="bedriver(HVOOrganisatoriskEnhetLogical)" />
</mapping>
</element>
<element id="HealthcareService.category">
<path value="HealthcareService.category" />
<short value="What type of goal oriented work is being done, e.g. logopedics." />
<mustSupport value="true" />
<identity value="HVOBusinessToHVOVerksamhetLogical" />
<map value="typ" />
</mapping>
</element>
<element id="HealthcareService.category.coding">
<path value="HealthcareService.category.coding" />
<type value="value" />
<path value="system" />
</discriminator>
<description value="Slice on CodeableConcept.coding based on the system value" />
<ordered value="false" />
<rules value="open" />
</slicing>
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="HealthcareService.category.coding:HVOBusinessType">
<path value="HealthcareService.category.coding" />
<sliceName value="HVOBusinessType" />
<min value="0" />
<max value="1" />
<mustSupport value="true" />
<strength value="required" />
<valueSet value="http://electronichealth.se/hvo/ValueSet/hvo-business-category" />
</binding>
</element>
<element id="HealthcareService.category.coding:HVOBusinessType.system">
<path value="HealthcareService.category.coding.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="HealthcareService.category.coding:HVOBusinessType.code">
<path value="HealthcareService.category.coding.code" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="HealthcareService.category.coding:HSABusinessType">
<path value="HealthcareService.category.coding" />
<sliceName value="HSABusinessType" />
<min value="0" />
<max value="1" />
<mustSupport value="true" />
<strength value="required" />
<valueSet value="http://electronichealth.se/hvo/ValueSet/hvo-business-category-inera" />
</binding>
</element>
<element id="HealthcareService.category.coding:HSABusinessType.system">
<path value="HealthcareService.category.coding.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="HealthcareService.category.coding:HSABusinessType.code">
<path value="HealthcareService.category.coding.code" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="HealthcareService.location">
<path value="HealthcareService.location" />
<code value="Reference" />
<targetProfile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOLocation" />
</type>
<mustSupport value="true" />
<identity value="HVOBusinessToHVOVerksamhetLogical" />
<map value="bedrivsPa(HVOPlatsLogical)" />
</mapping>
</element>
<element id="HealthcareService.availableTime">
<path value="HealthcareService.availableTime" />
<mustSupport value="true" />
<identity value="HVOBusinessToHVOVerksamhetLogical" />
<map value="harOppetUnder(HVOTillganglighetstidLogical)" />
</mapping>
</element>
<element id="HealthcareService.availableTime.daysOfWeek">
<path value="HealthcareService.availableTime.daysOfWeek" />
<mustSupport value="true" />
<strength value="required" />
<valueSet value="http://hl7.org/fhir/ValueSet/days-of-week" />
</binding>
</element>
<element id="HealthcareService.availableTime.allDay">
<path value="HealthcareService.availableTime.allDay" />
<mustSupport value="true" />
</element>
<element id="HealthcareService.availableTime.availableStartTime">
<path value="HealthcareService.availableTime.availableStartTime" />
<mustSupport value="true" />
</element>
<element id="HealthcareService.availableTime.availableEndTime">
<path value="HealthcareService.availableTime.availableEndTime" />
<mustSupport value="true" />
</element>
<element id="HealthcareService.notAvailable">
<path value="HealthcareService.notAvailable" />
<mustSupport value="true" />
<identity value="HVOBusinessToHVOVerksamhetLogical" />
<map value="harTillganglighetsavvikelse(HVOStorningsinformationLogical)" />
</mapping>
</element>
<element id="HealthcareService.notAvailable.description">
<path value="HealthcareService.notAvailable.description" />
<mustSupport value="true" />
</element>
<element id="HealthcareService.notAvailable.during">
<path value="HealthcareService.notAvailable.during" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="HealthcareService.notAvailable.during.start">
<path value="HealthcareService.notAvailable.during.start" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="HealthcareService.notAvailable.during.end">
<path value="HealthcareService.notAvailable.during.end" />
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "HVOBusiness",
"url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOBusiness",
"version": "0.1.0",
"name": "HVOBusiness",
"status": "draft",
"description": "HVOBusiness contains information about work which is conducted within a line of work",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "HVOBusinessToHVOVerksamhetLogical",
"uri": "HVOVerksamhetLogical"
}
],
"kind": "resource",
"abstract": false,
"type": "HealthcareService",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/HealthcareService",
"derivation": "constraint",
"element": [
{
"id": "HealthcareService.providedBy",
"path": "HealthcareService.providedBy",
"min": 1,
"type": [
{
"code": "Reference",
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit"
]
}
],
"mustSupport": true,
"mapping": [
{
"identity": "HVOBusinessToHVOVerksamhetLogical",
"map": "bedriver(HVOOrganisatoriskEnhetLogical)"
}
]
},
{
"id": "HealthcareService.category",
"path": "HealthcareService.category",
"short": "What type of goal oriented work is being done, e.g. logopedics.",
"mustSupport": true,
"mapping": [
{
"identity": "HVOBusinessToHVOVerksamhetLogical",
"map": "typ"
}
]
},
{
"id": "HealthcareService.category.coding",
"path": "HealthcareService.category.coding",
"slicing": {
{
"type": "value",
"path": "system"
}
],
"rules": "open",
"ordered": false,
"description": "Slice on CodeableConcept.coding based on the system value"
},
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "HealthcareService.category.coding:HVOBusinessType",
"path": "HealthcareService.category.coding",
"sliceName": "HVOBusinessType",
"min": 0,
"max": "1",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/hvo/ValueSet/hvo-business-category"
}
},
{
"id": "HealthcareService.category.coding:HVOBusinessType.system",
"path": "HealthcareService.category.coding.system",
"min": 1,
"mustSupport": true
},
{
"id": "HealthcareService.category.coding:HVOBusinessType.code",
"path": "HealthcareService.category.coding.code",
"min": 1,
"mustSupport": true
},
{
"id": "HealthcareService.category.coding:HSABusinessType",
"path": "HealthcareService.category.coding",
"sliceName": "HSABusinessType",
"min": 0,
"max": "1",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/hvo/ValueSet/hvo-business-category-inera"
}
},
{
"id": "HealthcareService.category.coding:HSABusinessType.system",
"path": "HealthcareService.category.coding.system",
"min": 1,
"mustSupport": true
},
{
"id": "HealthcareService.category.coding:HSABusinessType.code",
"path": "HealthcareService.category.coding.code",
"min": 1,
"mustSupport": true
},
{
"id": "HealthcareService.location",
"path": "HealthcareService.location",
"type": [
{
"code": "Reference",
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOLocation"
]
}
],
"mustSupport": true,
"mapping": [
{
"identity": "HVOBusinessToHVOVerksamhetLogical",
"map": "bedrivsPa(HVOPlatsLogical)"
}
]
},
{
"id": "HealthcareService.availableTime",
"path": "HealthcareService.availableTime",
"mustSupport": true,
"mapping": [
{
"identity": "HVOBusinessToHVOVerksamhetLogical",
"map": "harOppetUnder(HVOTillganglighetstidLogical)"
}
]
},
{
"id": "HealthcareService.availableTime.daysOfWeek",
"path": "HealthcareService.availableTime.daysOfWeek",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/days-of-week"
}
},
{
"id": "HealthcareService.availableTime.allDay",
"path": "HealthcareService.availableTime.allDay",
"mustSupport": true
},
{
"id": "HealthcareService.availableTime.availableStartTime",
"path": "HealthcareService.availableTime.availableStartTime",
"mustSupport": true
},
{
"id": "HealthcareService.availableTime.availableEndTime",
"path": "HealthcareService.availableTime.availableEndTime",
"mustSupport": true
},
{
"id": "HealthcareService.notAvailable",
"path": "HealthcareService.notAvailable",
"mustSupport": true,
"mapping": [
{
"identity": "HVOBusinessToHVOVerksamhetLogical",
"map": "harTillganglighetsavvikelse(HVOStorningsinformationLogical)"
}
]
},
{
"id": "HealthcareService.notAvailable.description",
"path": "HealthcareService.notAvailable.description",
"mustSupport": true
},
{
"id": "HealthcareService.notAvailable.during",
"path": "HealthcareService.notAvailable.during",
"min": 1,
"mustSupport": true
},
{
"id": "HealthcareService.notAvailable.during.start",
"path": "HealthcareService.notAvailable.during.start",
"min": 1,
"mustSupport": true
},
{
"id": "HealthcareService.notAvailable.during.end",
"path": "HealthcareService.notAvailable.during.end",
"mustSupport": true
}
]
}
}

Details

The must-support flag indicates that the element is expected in some use cases, and a missing flag that the element is never used.

See this example of HVOOrganizationalUnit which examplifies a contained HVOBusiness.

Validation rules

This section describes constraints and rules for this resource which POST and PUT request bodies are validated against. A rule consists of an ID, a human readable description and a machine readable expression written in FHIRPath. A rule break can result in either a warning or an error. This result is returned together with an error code and message. See Profiles for more information on resource constraints and Error handling for more information on error handling. Rules that relate directly to the format or content of a specific element can also be found by hovering over that element in the view above, under "Constraints" in the pop up card.

Rule ID Element Description Expression Error Severity
hvo-time-1 notAvailable.during.start, notAvailable.during.end The format is hh:mm:ss. The time "24:00" SHALL NOT be used. A timezone offset SHALL NOT be present. Reference: HL7 time datatype definition. Example: 07:00:00 ([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})? Error
per-1 notAvailable.during If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end) 2-34-318: Startdatumet i en period måste ha ett lägre värde än slutdatumet om båda är angivna Error