SPL Mapping FHIR R5 Implementation Guide
0.2.1 - Build CI
SPL Mapping FHIR R5 Implementation Guide
0.2.1 - Build CI
SPL Mapping FHIR R5 Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/LabelerBusinessOperation | Version: 0.2.1 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: LabelerBusinessOperation | ||
A profile that associates a Labeler to the set of business operations that it can perform.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HealthcareService |
C | 0..* | HealthcareService | The details of a healthcare service available at a location spl-5.1.5.7: Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401) spl-5.1.5.11: If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709 spl-5.1.5.12: If operation is C73608, then qualifier is C111077 and/or C111078 spl-5.1.5.13: If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095 |
  providedBy |
S | 1..1 | Reference(LabelerOrganization) | Organization that provides this service |
 type |
S | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: Labeler Business Operations (required) |
 serviceProvisionCode |
S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Business Operation Qualifiers (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.type | required | LabelerBusinessOperationshttp://hl7.org/fhir/us/spl/ValueSet/valueset-labelerBusinessOperationsfrom this IG | |
| HealthcareService.serviceProvisionCode | required | BusinessOperationQualifiershttp://hl7.org/fhir/us/spl/ValueSet/valueset-businessOperationQualifiersfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| spl-5.1.5.11 | error | HealthcareService | If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709 : type.coding.where(code = 'C43360').exists() implies serviceProvisionCode.coding.select(code in ('C106643' | 'C131710' | 'C131708' | 'C131709')).allTrue() | |
| spl-5.1.5.12 | error | HealthcareService | If operation is C73608, then qualifier is C111077 and/or C111078 : type.coding.where(code = 'C73608').exists() implies serviceProvisionCode.coding.select(code in ('C111077' | 'C111078')).allTrue() | |
| spl-5.1.5.13 | error | HealthcareService | If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095 : type.coding.where(code = 'C112113').exists() implies serviceProvisionCode.coding.select(code in ('C112087' | 'C112091' | 'C112092' | 'C112093' | 'C112094' | 'C112095')).allTrue() | |
| spl-5.1.5.7 | error | HealthcareService | Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401) : type.coding.where(code = 'C25391').exists() or type.coding.where(code = 'C82401').exists() or serviceProvisionCode.count() > 0 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService |
C | 0..* | HealthcareService | The details of a healthcare service available at a location spl-5.1.5.7: Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401) spl-5.1.5.11: If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709 spl-5.1.5.12: If operation is C73608, then qualifier is C111077 and/or C111078 spl-5.1.5.13: If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095 |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| active |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
| providedBy |
SΣ | 1..1 | Reference(LabelerOrganization) | Organization that provides this service |
 type |
SΣ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: Labeler Business Operations (required) |
| serviceProvisionCode |
S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Business Operation Qualifiers (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.type | required | LabelerBusinessOperationshttp://hl7.org/fhir/us/spl/ValueSet/valueset-labelerBusinessOperationsfrom this IG | |
| HealthcareService.serviceProvisionCode | required | BusinessOperationQualifiershttp://hl7.org/fhir/us/spl/ValueSet/valueset-businessOperationQualifiersfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | HealthcareService | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| spl-5.1.5.11 | error | HealthcareService | If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709 : type.coding.where(code = 'C43360').exists() implies serviceProvisionCode.coding.select(code in ('C106643' | 'C131710' | 'C131708' | 'C131709')).allTrue() | |
| spl-5.1.5.12 | error | HealthcareService | If operation is C73608, then qualifier is C111077 and/or C111078 : type.coding.where(code = 'C73608').exists() implies serviceProvisionCode.coding.select(code in ('C111077' | 'C111078')).allTrue() | |
| spl-5.1.5.13 | error | HealthcareService | If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095 : type.coding.where(code = 'C112113').exists() implies serviceProvisionCode.coding.select(code in ('C112087' | 'C112091' | 'C112092' | 'C112093' | 'C112094' | 'C112095')).allTrue() | |
| spl-5.1.5.7 | error | HealthcareService | Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401) : type.coding.where(code = 'C25391').exists() or type.coding.where(code = 'C82401').exists() or serviceProvisionCode.count() > 0 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
C | 0..* | HealthcareService | The details of a healthcare service available at a location spl-5.1.5.7: Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401) spl-5.1.5.11: If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709 spl-5.1.5.12: If operation is C73608, then qualifier is C111077 and/or C111078 spl-5.1.5.13: If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External identifiers for this item | ||||
| active |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use | ||||
| providedBy |
SΣ | 1..1 | Reference(LabelerOrganization) | Organization that provides this service | ||||
| offeredIn |
0..* | Reference(HealthcareService) | The service within which this service is offered | |||||
| category |
Σ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
| type |
SΣ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: Labeler Business Operations (required) | ||||
| specialty |
Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | ||||
| location |
Σ | 0..* | Reference(Location) | Location(s) where service may be provided | ||||
| name |
Σ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
| comment |
Σ | 0..1 | markdown | Additional description and/or any specific issues not covered elsewhere | ||||
| extraDetails |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo |
Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
| contact |
0..* | ExtendedContactDetail | Official contact details for the HealthcareService | |||||
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode |
S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Business Operation Qualifiers (required) | ||||
 eligibility |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description (No ValueSet): (example): Coded values underwhich a specific service is made available. | |||||
| comment |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
| characteristic |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility). | |||||
| communication |
0..* | CodeableConcept | The language that this service is offered in Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| referralMethod |
0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthcareService resource. | |||||
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |||||
| availability |
0..* | Availability | Times the healthcare service is available (including exceptions) | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | |
| HealthcareService.type | required | LabelerBusinessOperationshttp://hl7.org/fhir/us/spl/ValueSet/valueset-labelerBusinessOperationsfrom this IG | |
| HealthcareService.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard | |
| HealthcareService.serviceProvisionCode | required | BusinessOperationQualifiershttp://hl7.org/fhir/us/spl/ValueSet/valueset-businessOperationQualifiersfrom this IG | |
| HealthcareService.eligibility.code | example | ||
| HealthcareService.program | example | Programhttp://hl7.org/fhir/ValueSet/programfrom the FHIR Standard | |
| HealthcareService.characteristic | example | ServiceModehttp://hl7.org/fhir/ValueSet/service-modefrom the FHIR Standard | |
| HealthcareService.communication | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-methodfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | HealthcareService | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| spl-5.1.5.11 | error | HealthcareService | If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709 : type.coding.where(code = 'C43360').exists() implies serviceProvisionCode.coding.select(code in ('C106643' | 'C131710' | 'C131708' | 'C131709')).allTrue() | |
| spl-5.1.5.12 | error | HealthcareService | If operation is C73608, then qualifier is C111077 and/or C111078 : type.coding.where(code = 'C73608').exists() implies serviceProvisionCode.coding.select(code in ('C111077' | 'C111078')).allTrue() | |
| spl-5.1.5.13 | error | HealthcareService | If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095 : type.coding.where(code = 'C112113').exists() implies serviceProvisionCode.coding.select(code in ('C112087' | 'C112091' | 'C112092' | 'C112093' | 'C112094' | 'C112095')).allTrue() | |
| spl-5.1.5.7 | error | HealthcareService | Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401) : type.coding.where(code = 'C25391').exists() or type.coding.where(code = 'C82401').exists() or serviceProvisionCode.count() > 0 |
This structure is derived from HealthcareService
Summary
Mandatory: 2 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Maturity: 1
Differential View
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService |
C | 0..* | HealthcareService | The details of a healthcare service available at a location spl-5.1.5.7: Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401) spl-5.1.5.11: If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709 spl-5.1.5.12: If operation is C73608, then qualifier is C111077 and/or C111078 spl-5.1.5.13: If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095 |
| providedBy |
S | 1..1 | Reference(LabelerOrganization) | Organization that provides this service |
| type |
S | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: Labeler Business Operations (required) |
| serviceProvisionCode |
S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Business Operation Qualifiers (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.type | required | LabelerBusinessOperationshttp://hl7.org/fhir/us/spl/ValueSet/valueset-labelerBusinessOperationsfrom this IG | |
| HealthcareService.serviceProvisionCode | required | BusinessOperationQualifiershttp://hl7.org/fhir/us/spl/ValueSet/valueset-businessOperationQualifiersfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| spl-5.1.5.11 | error | HealthcareService | If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709 : type.coding.where(code = 'C43360').exists() implies serviceProvisionCode.coding.select(code in ('C106643' | 'C131710' | 'C131708' | 'C131709')).allTrue() | |
| spl-5.1.5.12 | error | HealthcareService | If operation is C73608, then qualifier is C111077 and/or C111078 : type.coding.where(code = 'C73608').exists() implies serviceProvisionCode.coding.select(code in ('C111077' | 'C111078')).allTrue() | |
| spl-5.1.5.13 | error | HealthcareService | If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095 : type.coding.where(code = 'C112113').exists() implies serviceProvisionCode.coding.select(code in ('C112087' | 'C112091' | 'C112092' | 'C112093' | 'C112094' | 'C112095')).allTrue() | |
| spl-5.1.5.7 | error | HealthcareService | Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401) : type.coding.where(code = 'C25391').exists() or type.coding.where(code = 'C82401').exists() or serviceProvisionCode.count() > 0 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService |
C | 0..* | HealthcareService | The details of a healthcare service available at a location spl-5.1.5.7: Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401) spl-5.1.5.11: If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709 spl-5.1.5.12: If operation is C73608, then qualifier is C111077 and/or C111078 spl-5.1.5.13: If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| active |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
| providedBy |
SΣ | 1..1 | Reference(LabelerOrganization) | Organization that provides this service |
| type |
SΣ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: Labeler Business Operations (required) |
| serviceProvisionCode |
S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Business Operation Qualifiers (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.type | required | LabelerBusinessOperationshttp://hl7.org/fhir/us/spl/ValueSet/valueset-labelerBusinessOperationsfrom this IG | |
| HealthcareService.serviceProvisionCode | required | BusinessOperationQualifiershttp://hl7.org/fhir/us/spl/ValueSet/valueset-businessOperationQualifiersfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | HealthcareService | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| spl-5.1.5.11 | error | HealthcareService | If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709 : type.coding.where(code = 'C43360').exists() implies serviceProvisionCode.coding.select(code in ('C106643' | 'C131710' | 'C131708' | 'C131709')).allTrue() | |
| spl-5.1.5.12 | error | HealthcareService | If operation is C73608, then qualifier is C111077 and/or C111078 : type.coding.where(code = 'C73608').exists() implies serviceProvisionCode.coding.select(code in ('C111077' | 'C111078')).allTrue() | |
| spl-5.1.5.13 | error | HealthcareService | If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095 : type.coding.where(code = 'C112113').exists() implies serviceProvisionCode.coding.select(code in ('C112087' | 'C112091' | 'C112092' | 'C112093' | 'C112094' | 'C112095')).allTrue() | |
| spl-5.1.5.7 | error | HealthcareService | Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401) : type.coding.where(code = 'C25391').exists() or type.coding.where(code = 'C82401').exists() or serviceProvisionCode.count() > 0 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
C | 0..* | HealthcareService | The details of a healthcare service available at a location spl-5.1.5.7: Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401) spl-5.1.5.11: If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709 spl-5.1.5.12: If operation is C73608, then qualifier is C111077 and/or C111078 spl-5.1.5.13: If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External identifiers for this item | ||||
| active |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use | ||||
| providedBy |
SΣ | 1..1 | Reference(LabelerOrganization) | Organization that provides this service | ||||
| offeredIn |
0..* | Reference(HealthcareService) | The service within which this service is offered | |||||
| category |
Σ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
| type |
SΣ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: Labeler Business Operations (required) | ||||
| specialty |
Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | ||||
| location |
Σ | 0..* | Reference(Location) | Location(s) where service may be provided | ||||
| name |
Σ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
| comment |
Σ | 0..1 | markdown | Additional description and/or any specific issues not covered elsewhere | ||||
| extraDetails |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo |
Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
| contact |
0..* | ExtendedContactDetail | Official contact details for the HealthcareService | |||||
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode |
S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Business Operation Qualifiers (required) | ||||
| eligibility |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description (No ValueSet): (example): Coded values underwhich a specific service is made available. | |||||
| comment |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
| characteristic |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility). | |||||
| communication |
0..* | CodeableConcept | The language that this service is offered in Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| referralMethod |
0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthcareService resource. | |||||
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |||||
| availability |
0..* | Availability | Times the healthcare service is available (including exceptions) | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | |
| HealthcareService.type | required | LabelerBusinessOperationshttp://hl7.org/fhir/us/spl/ValueSet/valueset-labelerBusinessOperationsfrom this IG | |
| HealthcareService.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard | |
| HealthcareService.serviceProvisionCode | required | BusinessOperationQualifiershttp://hl7.org/fhir/us/spl/ValueSet/valueset-businessOperationQualifiersfrom this IG | |
| HealthcareService.eligibility.code | example | ||
| HealthcareService.program | example | Programhttp://hl7.org/fhir/ValueSet/programfrom the FHIR Standard | |
| HealthcareService.characteristic | example | ServiceModehttp://hl7.org/fhir/ValueSet/service-modefrom the FHIR Standard | |
| HealthcareService.communication | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-methodfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | HealthcareService | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| spl-5.1.5.11 | error | HealthcareService | If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709 : type.coding.where(code = 'C43360').exists() implies serviceProvisionCode.coding.select(code in ('C106643' | 'C131710' | 'C131708' | 'C131709')).allTrue() | |
| spl-5.1.5.12 | error | HealthcareService | If operation is C73608, then qualifier is C111077 and/or C111078 : type.coding.where(code = 'C73608').exists() implies serviceProvisionCode.coding.select(code in ('C111077' | 'C111078')).allTrue() | |
| spl-5.1.5.13 | error | HealthcareService | If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095 : type.coding.where(code = 'C112113').exists() implies serviceProvisionCode.coding.select(code in ('C112087' | 'C112091' | 'C112092' | 'C112093' | 'C112094' | 'C112095')).allTrue() | |
| spl-5.1.5.7 | error | HealthcareService | Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401) : type.coding.where(code = 'C25391').exists() or type.coding.where(code = 'C82401').exists() or serviceProvisionCode.count() > 0 |
This structure is derived from HealthcareService
Summary
Mandatory: 2 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Biomedical Research and Regulation. Package hl7.fhir.us.spl#0.2.1 based on FHIR 5.0.0. Generated 2024-10-26
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change