{
"description": "Base profile for Australian context Healthcare Service",
"_filename": "StructureDefinition-au-healthcareservice.json",
"package_name": "hl7.fhir.au.base",
"date": "2018-08-03T00:00:00+10:00",
"derivation": "constraint",
"meta": {
"lastUpdated": "2018-03-12T22:29:35.557+11:00"
},
"publisher": "Health Level Seven Australia (Patient Administration WG)",
"fhirVersion": "3.0.1",
"name": "AUBaseHealthcareService",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
} ],
"abstract": false,
"type": "HealthcareService",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "AU Base Healthcare Service",
"package_version": "1.0.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "HealthcareService",
"min": 0,
"definition": "The details of a healthcare service.",
"short": "A healthcare service in an Australian healthcare context",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "act[classCode=ACT][moodCode=DEF]",
"identity": "rim"
}, {
"map": "administrative.group",
"identity": "w5"
} ],
"max": "*",
"id": "HealthcareService",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService"
}
}, {
"path": "HealthcareService.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "HealthcareService.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "HealthcareService.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "HealthcareService.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "HealthcareService.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "HealthcareService.implicitRules",
"comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "HealthcareService.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "HealthcareService.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "HealthcareService.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "HealthcareService.text",
"condition": [ "dom-1" ],
"comment": "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 in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "HealthcareService.contained",
"min": 0,
"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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "HealthcareService.contained",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "HealthcareService.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "HealthcareService.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.extension",
"min": 0,
"definition": "Requirements for eligibility for a healthcare service.",
"short": "Healthcare Service Eligibility Detail",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org.au/fhir/StructureDefinition/healthcareservice-eligibility-detail"
} ],
"sliceName": "eligibilityDetails",
"max": "*",
"id": "HealthcareService.extension:eligibilityDetails",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.extension",
"min": 0,
"definition": "Communication languages support the healthcare service can provide",
"short": "Healthcare Service Communication Languages",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org.au/fhir/StructureDefinition/healthcareservice-communication"
} ],
"sliceName": "communication",
"max": "*",
"id": "HealthcareService.extension:communication",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "HealthcareService.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "HealthcareService.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "HealthcareService.identifier",
"min": 0,
"definition": "External identifiers for this item.",
"short": "Healthcare service identifiers",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
}, {
"path": "type",
"type": "value"
} ]
},
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "HealthcareService.identifier",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.identifier"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier",
"min": 0,
"definition": "National identifier Health Provider Identifier for Organisations (HPI-O).",
"short": "Healthcare Provider Identifier – Organisation (HPI-O)",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"sliceName": "hpio",
"max": "*",
"id": "HealthcareService.identifier:hpio",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.identifier"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HealthcareService.identifier:hpio.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "HealthcareService.identifier.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "HealthcareService.identifier:hpio.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "HealthcareService.identifier.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"max": "1",
"id": "HealthcareService.identifier:hpio.use",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"definition": "Healthcare Provider Identifier – Organisation (HPI-O) identifier type.",
"short": "Identifier type for HPI-O",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Local identifier type",
"valueSetReference": {
"reference": "http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203"
}
},
"max": "1",
"id": "HealthcareService.identifier:hpio.type",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier.type.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HealthcareService.identifier:hpio.type.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "HealthcareService.identifier.type.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "HealthcareService.identifier:hpio.type.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "HealthcareService.identifier.type.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "hpi-o",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "1",
"id": "HealthcareService.identifier:hpio.type.coding",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier.type.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HealthcareService.identifier:hpio.type.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "HealthcareService.identifier.type.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "HealthcareService.identifier:hpio.type.coding.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "HealthcareService.identifier.type.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "http://hl7.org.au/fhir/v2/0203",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "HealthcareService.identifier:hpio.type.coding.system",
"comment": "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 de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier.type.coding.version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HealthcareService.identifier:hpio.type.coding.version",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier.type.coding.code",
"fixedCode": "NOI",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"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).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "HealthcareService.identifier:hpio.type.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier.type.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "HealthcareService.identifier:hpio.type.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier.type.coding.userSelected",
"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.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "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 ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "HealthcareService.identifier:hpio.type.coding.userSelected",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier.type.text",
"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.",
"min": 0,
"definition": "hpi-o",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"fixedString": "HPI-O",
"id": "HealthcareService.identifier:hpio.type.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier.system",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 1,
"definition": "This namespace is used for qualified identifiers to represent Healthcare Provider Identifier for Organisations (HPI-O) numbers. An example of the syntax of a HPI-O represented as a qualified identifer using this namespace is: http://ns.electronichealth.net.au/id/hi/hpio/1.0/8003620000000000",
"short": "Namespace for HPI-O",
"fixedUri": "http://ns.electronichealth.net.au/id/hi/hpio/1.0",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "HealthcareService.identifier:hpio.system",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "inv-hpio-0",
"human": "HPI-O shall be an exactly 16 digit number",
"severity": "error",
"expression": "matches('^([0-9]{16})$')"
}, {
"key": "inv-hpio-1",
"human": "HPI-O prefix is 800362",
"severity": "error",
"expression": "startsWith('800362')"
}, {
"key": "inv-hpio-2",
"human": "HPI-O shall pass the Luhn algorithm check",
"severity": "error",
"expression": "(((select(substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(1,1).toInteger())+(select(substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(3,1).toInteger())+(select(substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(5,1).toInteger())+(select(substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(7,1).toInteger())+(select(substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(9,1).toInteger())+(select(substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(11,1).toInteger())+(select(substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(13,1).toInteger())+(select(substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(15,1).toInteger()))mod 10=0)"
} ],
"path": "HealthcareService.identifier.value",
"min": 1,
"definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"short": "HPI-O number",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HealthcareService.identifier:hpio.value",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).",
"maxLength": 16,
"example": [ {
"label": "General",
"valueString": "123456"
}, {
"label": "HPI-O number",
"valueString": "8003627500000328"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "HealthcareService.identifier:hpio.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "HealthcareService.identifier:hpio.assigner",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"path": "HealthcareService.active",
"min": 0,
"definition": "Whether this healthcareservice record is in active use.",
"isModifier": true,
"short": "Whether this healthcareservice is in active use",
"mapping": [ {
"map": ".statusCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"defaultValueBoolean": true,
"max": "1",
"id": "HealthcareService.active",
"comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.active"
},
"isSummary": true
}, {
"path": "HealthcareService.providedBy",
"min": 0,
"definition": "The organization that provides this healthcare service.",
"short": "Organization that provides this service",
"mapping": [ {
"map": ".scopingRole.Organization",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "HealthcareService.providedBy",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.providedBy"
},
"isSummary": true
}, {
"path": "HealthcareService.category",
"min": 0,
"definition": "Identifies the broad category of service being performed or delivered.",
"short": "Broad category of service being performed or delivered",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-category"
} ],
"description": "A category of the service(s) that could be provided.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-category"
}
},
"alias": [ "service category" ],
"max": "1",
"id": "HealthcareService.category",
"comment": "Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.category"
},
"isSummary": true
}, {
"path": "HealthcareService.type",
"min": 0,
"definition": "The specific type of service that may be delivered or performed.",
"short": "Type of service that may be delivered or performed",
"mapping": [ {
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-type"
} ],
"description": "Additional details about where the content was created (e.g. clinical specialty).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-type"
}
},
"alias": [ "service type" ],
"max": "*",
"id": "HealthcareService.type",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.type"
},
"isSummary": true
}, {
"path": "HealthcareService.specialty",
"min": 0,
"definition": "Collection of specialties handled by the service site. This is more of a medical term.",
"short": "Healthcare service provided specialties",
"mapping": [ {
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "coding.system",
"type": "value"
} ]
},
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-specialty"
} ],
"description": "A specialty that a healthcare service may provide.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes"
}
},
"max": "*",
"id": "HealthcareService.specialty",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.specialty"
},
"isSummary": true
}, {
"path": "HealthcareService.specialty",
"min": 0,
"definition": "Collection of specialties handled by the service site. This is more of a medical term.",
"short": "Healthcare Service Specialty SNOMED CT",
"mapping": [ {
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"sliceName": "snomedRole",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-specialty"
} ],
"description": "Healthcare Specialties",
"valueSetReference": {
"reference": "http://hl7.org.au/fhir/ValueSet/snomed-healthcareservice-services"
}
},
"max": "*",
"id": "HealthcareService.specialty:snomedRole",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.specialty"
},
"isSummary": true
}, {
"path": "HealthcareService.location",
"min": 0,
"definition": "The location(s) where this healthcare service may be provided.",
"short": "Location(s) where service may be provided",
"mapping": [ {
"map": ".location.role[classCode=SDLOC]",
"identity": "rim"
}, {
"map": "where",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
} ],
"max": "*",
"id": "HealthcareService.location",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.location"
},
"isSummary": true
}, {
"path": "HealthcareService.name",
"min": 0,
"definition": "Further description of the service as it would be presented to a consumer while searching.",
"short": "Description of service as presented to a consumer while searching",
"mapping": [ {
"map": ".name",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HealthcareService.name",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.name"
},
"isSummary": true
}, {
"path": "HealthcareService.comment",
"min": 0,
"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.",
"short": "Additional description and/or any specific issues not covered elsewhere",
"mapping": [ {
"map": ".location.role[classCode=SDLOC].desc",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HealthcareService.comment",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.comment"
},
"isSummary": true
}, {
"path": "HealthcareService.extraDetails",
"min": 0,
"definition": "Extra details about the service that can't be placed in the other fields.",
"short": "Extra details about the service that can't be placed in the other fields",
"mapping": [ {
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].text",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HealthcareService.extraDetails",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.extraDetails"
}
}, {
"path": "HealthcareService.photo",
"min": 0,
"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.",
"short": "Facilitates quick identification of the service",
"mapping": [ {
"map": ".actrelationship[typeCode=SBJ].observation.value",
"identity": "rim"
} ],
"type": [ {
"code": "Attachment"
} ],
"max": "1",
"id": "HealthcareService.photo",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.photo"
},
"isSummary": true
}, {
"path": "HealthcareService.telecom",
"min": 0,
"definition": "List of contacts related to this specific healthcare service.",
"short": "Contacts related to the healthcare service",
"mapping": [ {
"map": ".telecom",
"identity": "rim"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"max": "*",
"id": "HealthcareService.telecom",
"comment": "If this is empty, then refer to the location's contacts.",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.telecom"
}
}, {
"path": "HealthcareService.coverageArea",
"min": 0,
"definition": "The location(s) that this service is available to (not where the service is provided).",
"short": "Location(s) service is inteded for/available to",
"mapping": [ {
"map": ".location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
} ],
"max": "*",
"id": "HealthcareService.coverageArea",
"comment": "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\".",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.coverageArea"
}
}, {
"path": "HealthcareService.serviceProvisionCode",
"min": 0,
"definition": "The code(s) that detail the conditions under which the healthcare service is available/offered.",
"short": "Healthcare service provision conditions",
"mapping": [ {
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "coding.system",
"type": "value"
} ]
},
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceProvisionConditions"
} ],
"description": "The code(s) that detail the conditions under which the healthcare service is available/offered.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-provision-conditions"
}
},
"max": "*",
"id": "HealthcareService.serviceProvisionCode",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.serviceProvisionCode"
}
}, {
"path": "HealthcareService.serviceProvisionCode",
"min": 0,
"definition": "The code(s) that detail the conditions under which the healthcare service is available/offered.",
"short": "Australian service provision conditions",
"mapping": [ {
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"sliceName": "auServiceProvisionCode",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceProvisionConditions"
} ],
"valueSetReference": {
"reference": "http://hl7.org.au/fhir/ValueSet/service-provision-conditions"
}
},
"max": "*",
"id": "HealthcareService.serviceProvisionCode:auServiceProvisionCode",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.serviceProvisionCode"
}
}, {
"path": "HealthcareService.eligibility",
"min": 0,
"definition": "Primary eligibility criterial for service.",
"short": "Primary eligibility criteria for service",
"mapping": [ {
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceEligibility"
} ],
"description": "Coded values underwhich a specific service is made available."
},
"max": "1",
"id": "HealthcareService.eligibility",
"comment": "The extension Healthcare Service; eligibilityDetails allows for specific desciption of multiple criteria.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.eligibility"
}
}, {
"path": "HealthcareService.eligibilityNote",
"min": 0,
"definition": "Describes the eligibility conditions for the service.",
"short": "Describes the eligibility conditions for the service",
"mapping": [ {
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HealthcareService.eligibilityNote",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.eligibilityNote"
}
}, {
"path": "HealthcareService.programName",
"min": 0,
"definition": "Program Names that can be used to categorize the service.",
"short": "Program Names that categorize the service",
"mapping": [ {
"map": ".actrelationship[typeCode=PERT].observation",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "HealthcareService.programName",
"comment": "Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.programName"
}
}, {
"path": "HealthcareService.characteristic",
"min": 0,
"definition": "Collection of characteristics (attributes).",
"short": "Collection of characteristics (attributes)",
"mapping": [ {
"map": ".actrelationship[typeCode=PERT].observation",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceCharacteristic"
} ],
"description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy)."
},
"max": "*",
"id": "HealthcareService.characteristic",
"comment": "These could be such things as is wheelchair accessible.",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.characteristic"
}
}, {
"path": "HealthcareService.referralMethod",
"min": 0,
"definition": "Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.",
"short": "Ways that the service accepts referrals",
"mapping": [ {
"map": ".actrelationship[typeCode=PERT].observation",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ReferralMethod"
} ],
"description": "The methods of referral can be used when referring to a specific HealthCareService resource.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-referral-method"
}
},
"max": "*",
"id": "HealthcareService.referralMethod",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.referralMethod"
}
}, {
"path": "HealthcareService.appointmentRequired",
"min": 0,
"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.",
"short": "If an appointment is required for access to this service",
"mapping": [ {
"map": ".actrelationship[typeCode=PERT].observation",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "HealthcareService.appointmentRequired",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.appointmentRequired"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "HealthcareService.availableTime",
"min": 0,
"definition": "A collection of times that the Service Site is available.",
"short": "Times the Service Site is available",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "HealthcareService.availableTime",
"comment": "More detailed availability information may be provided in associated Schedule/Slot resources.",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.availableTime"
}
}, {
"path": "HealthcareService.availableTime.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HealthcareService.availableTime.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "HealthcareService.availableTime.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "HealthcareService.availableTime.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "HealthcareService.availableTime.modifierExtension",
"min": 0,
"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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "HealthcareService.availableTime.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "HealthcareService.availableTime.daysOfWeek",
"min": 0,
"definition": "Indicates which days of the week are available between the start and end Times.",
"short": "mon | tue | wed | thu | fri | sat | sun",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DaysOfWeek"
} ],
"description": "The days of the week.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/days-of-week"
}
},
"max": "*",
"id": "HealthcareService.availableTime.daysOfWeek",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.availableTime.daysOfWeek"
}
}, {
"path": "HealthcareService.availableTime.allDay",
"min": 0,
"definition": "Is this always available? (hence times are irrelevant) e.g. 24 hour service.",
"short": "Always available? e.g. 24 hour service",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "HealthcareService.availableTime.allDay",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.availableTime.allDay"
}
}, {
"path": "HealthcareService.availableTime.availableStartTime",
"min": 0,
"definition": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.",
"short": "Opening time of day (ignored if allDay = true)",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "time"
} ],
"max": "1",
"id": "HealthcareService.availableTime.availableStartTime",
"comment": "The timezone is expected to be for where this HealthcareService is provided at.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.availableTime.availableStartTime"
}
}, {
"path": "HealthcareService.availableTime.availableEndTime",
"min": 0,
"definition": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.",
"short": "Closing time of day (ignored if allDay = true)",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "time"
} ],
"max": "1",
"id": "HealthcareService.availableTime.availableEndTime",
"comment": "The timezone is expected to be for where this HealthcareService is provided at.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.availableTime.availableEndTime"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "HealthcareService.notAvailable",
"min": 0,
"definition": "The HealthcareService is not available during this period of time due to the provided reason.",
"short": "Not available during this time due to provided reason",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "HealthcareService.notAvailable",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.notAvailable"
}
}, {
"path": "HealthcareService.notAvailable.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HealthcareService.notAvailable.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "HealthcareService.notAvailable.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "HealthcareService.notAvailable.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "HealthcareService.notAvailable.modifierExtension",
"min": 0,
"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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "HealthcareService.notAvailable.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "HealthcareService.notAvailable.description",
"min": 1,
"definition": "The reason that can be presented to the user as to why this time is not available.",
"short": "Reason presented to the user explaining why time not available",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HealthcareService.notAvailable.description",
"base": {
"max": "1",
"min": 1,
"path": "HealthcareService.notAvailable.description"
}
}, {
"path": "HealthcareService.notAvailable.during",
"min": 0,
"definition": "Service is not available (seasonally or for a public holiday) from this date.",
"short": "Service not availablefrom this date",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "HealthcareService.notAvailable.during",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.notAvailable.during"
}
}, {
"path": "HealthcareService.availabilityExceptions",
"min": 0,
"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.",
"short": "Description of availability exceptions",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HealthcareService.availabilityExceptions",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.availabilityExceptions"
}
}, {
"path": "HealthcareService.endpoint",
"requirements": "Organizations may have different systems covering different services at the different locations and need to be able to define the technical connection details for how to connect to them, and for what purpose.",
"min": 0,
"definition": "Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.",
"short": "Technical endpoints providing access to services operated for the location",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint"
} ],
"max": "*",
"id": "HealthcareService.endpoint",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.endpoint"
}
} ]
},
"status": "draft",
"id": "db090381-83f5-46ec-9b2e-63c48aeab7be",
"kind": "resource",
"url": "http://hl7.org.au/fhir/StructureDefinition/au-healthcareservice",
"version": "1.0.0",
"differential": {
"element": [ {
"id": "HealthcareService",
"path": "HealthcareService",
"short": "A healthcare service in an Australian healthcare context",
"definition": "The details of a healthcare service."
}, {
"id": "HealthcareService.extension",
"path": "HealthcareService.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "HealthcareService.extension:eligibilityDetails",
"path": "HealthcareService.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org.au/fhir/StructureDefinition/healthcareservice-eligibility-detail"
} ],
"short": "Healthcare Service Eligibility Detail",
"sliceName": "eligibilityDetails"
}, {
"id": "HealthcareService.extension:communication",
"path": "HealthcareService.extension",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org.au/fhir/StructureDefinition/healthcareservice-communication"
} ],
"short": "Healthcare Service Communication Languages",
"sliceName": "communication"
}, {
"id": "HealthcareService.identifier",
"path": "HealthcareService.identifier",
"short": "Healthcare service identifiers",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
}, {
"path": "type",
"type": "value"
} ]
}
}, {
"id": "HealthcareService.identifier:hpio",
"path": "HealthcareService.identifier",
"short": "Healthcare Provider Identifier – Organisation (HPI-O)",
"sliceName": "hpio",
"definition": "National identifier Health Provider Identifier for Organisations (HPI-O)."
}, {
"id": "HealthcareService.identifier:hpio.type",
"path": "HealthcareService.identifier.type",
"short": "Identifier type for HPI-O",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Local identifier type",
"valueSetReference": {
"reference": "http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203"
}
},
"definition": "Healthcare Provider Identifier – Organisation (HPI-O) identifier type."
}, {
"id": "HealthcareService.identifier:hpio.type.coding",
"max": "1",
"path": "HealthcareService.identifier.type.coding",
"definition": "hpi-o"
}, {
"id": "HealthcareService.identifier:hpio.type.coding.system",
"min": 1,
"path": "HealthcareService.identifier.type.coding.system",
"fixedUri": "http://hl7.org.au/fhir/v2/0203"
}, {
"id": "HealthcareService.identifier:hpio.type.coding.code",
"min": 1,
"path": "HealthcareService.identifier.type.coding.code",
"fixedCode": "NOI"
}, {
"id": "HealthcareService.identifier:hpio.type.text",
"path": "HealthcareService.identifier.type.text",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"definition": "hpi-o",
"fixedString": "HPI-O"
}, {
"id": "HealthcareService.identifier:hpio.system",
"min": 1,
"path": "HealthcareService.identifier.system",
"short": "Namespace for HPI-O",
"fixedUri": "http://ns.electronichealth.net.au/id/hi/hpio/1.0",
"definition": "This namespace is used for qualified identifiers to represent Healthcare Provider Identifier for Organisations (HPI-O) numbers. An example of the syntax of a HPI-O represented as a qualified identifer using this namespace is: http://ns.electronichealth.net.au/id/hi/hpio/1.0/8003620000000000"
}, {
"id": "HealthcareService.identifier:hpio.value",
"min": 1,
"path": "HealthcareService.identifier.value",
"short": "HPI-O number",
"example": [ {
"label": "HPI-O number",
"valueString": "8003627500000328"
} ],
"maxLength": 16,
"constraint": [ {
"key": "inv-hpio-0",
"human": "HPI-O shall be an exactly 16 digit number",
"severity": "error",
"expression": "matches('^([0-9]{16})$')"
}, {
"key": "inv-hpio-1",
"human": "HPI-O prefix is 800362",
"severity": "error",
"expression": "startsWith('800362')"
}, {
"key": "inv-hpio-2",
"human": "HPI-O shall pass the Luhn algorithm check",
"severity": "error",
"expression": "(((select(substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(1,1).toInteger())+(select(substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(3,1).toInteger())+(select(substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(5,1).toInteger())+(select(substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(7,1).toInteger())+(select(substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(9,1).toInteger())+(select(substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(11,1).toInteger())+(select(substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(13,1).toInteger())+(select(substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(15,1).toInteger()))mod 10=0)"
} ],
"definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems."
}, {
"id": "HealthcareService.specialty",
"path": "HealthcareService.specialty",
"short": "Healthcare service provided specialties",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "coding.system",
"type": "value"
} ]
}
}, {
"id": "HealthcareService.specialty:snomedRole",
"path": "HealthcareService.specialty",
"short": "Healthcare Service Specialty SNOMED CT",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-specialty"
} ],
"description": "Healthcare Specialties",
"valueSetReference": {
"reference": "http://hl7.org.au/fhir/ValueSet/snomed-healthcareservice-services"
}
},
"sliceName": "snomedRole"
}, {
"id": "HealthcareService.serviceProvisionCode",
"path": "HealthcareService.serviceProvisionCode",
"short": "Healthcare service provision conditions",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "coding.system",
"type": "value"
} ]
}
}, {
"id": "HealthcareService.serviceProvisionCode:auServiceProvisionCode",
"path": "HealthcareService.serviceProvisionCode",
"short": "Australian service provision conditions",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceProvisionConditions"
} ],
"valueSetReference": {
"reference": "http://hl7.org.au/fhir/ValueSet/service-provision-conditions"
}
},
"sliceName": "auServiceProvisionCode"
}, {
"id": "HealthcareService.eligibility",
"path": "HealthcareService.eligibility",
"short": "Primary eligibility criteria for service",
"comment": "The extension Healthcare Service; eligibilityDetails allows for specific desciption of multiple criteria.",
"definition": "Primary eligibility criterial for service."
} ]
},
"contact": [ {
"telecom": [ {
"use": "work",
"value": "http://hl7.org.au/fhir",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
}