Entities
HL7 Norway proposed basis profiles for Entity resources in HL7 FHIR.
Only attributes with actual profiling is included in the information model diagram.
no-basis-Endpoint
Basisprofil for Norwegian Endpoint information. Defined by The Norwegian Directorate of eHealth and HL7 Norway. The profile adds Norwegian specific identification of Endpoint. The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.
Endpoint for both for tjenestebasert adressering and other use-cases.
Link to the full documentation of the profile no-basis-Endpoint
Resource content
NoBasisEndpoint (Endpoint) | | | Endpoint | There are no (further) constraints on this element Element idDefinition The no-basis profile of the Endpoint resource makes it possible to use the resource for the norwegian service based adressing (tjenestebasert adressering) and other adressing schemes.
The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
Data type Endpoint |
identifier | | | | There are no (further) constraints on this element Element idComments no-basis: Adresseregisteret do not provide a identifier for the Endpoints, so any identifier scheme is apropriate.
|
connectionType | | | Binding | There are no (further) constraints on this element Element idDefinition no-basis: the connection type should be coded according to http://hl7.org/fhir/ValueSet/endpoint-connection-type. However specific connection types used in Norway can be coded according to http://hl7.no/fhir/ValueSet/no-basis-endpoint-connection-type (amqp, ebxml etc.)
A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
Binding NoBasisConnectionType (extensible) |
managingOrganization | | | Reference(Organization | no-basis-Organization) | There are no (further) constraints on this element Element idEndpoint.managingOrganization Alternate names dataansvarlig Definition The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).
no-basis: In Norway this relates to the organization with the responsibility for the data e.g. "dataansvarlig".
no-basis recommends the use of logical reference to an organization using ENH or RSH. To describe a top level organization. Departments within an organization could use a different reference scheme defined by the organization.
Data type Reference(Organization | no-basis-Organization) |
payloadType | | | | There are no (further) constraints on this element Element idDefinition no-basis: for ebXML and AMQP messages in Norway one is expected to list all mesage types that the endpoint supports using the CodeSystem Meldingens funksjon (OID=8279) as a minimum. To describe complete version information to determine the type and version of the messages the endpoint supports, a CapabilityStatement can be used to describe the endpoints communication capabilities in detail.
REST endpoints are expected to use the code "any" from https://www.hl7.org/fhir/codesystem-endpoint-payload-type.html. Proper FHIR Restful API's are expected to serve a CapabilityStatement from the base uri specified.
Other payload types can be given using codes from the ValueSet http://hl7.org/fhir/ValueSet/endpoint-payload-type.
The payload type describes the acceptable content that can be communicated on the endpoint.
Sliced: Unordered, Open, by coding.system(Value) |
meldingensFunksjon | | | Binding | There are no (further) constraints on this element Element idEndpoint.payloadType:meldingensFunksjon Definition no-basis: for ebXML and AMQP messages in Norway one is expected to list all mesage types that the endpoint supports using the CodeSystem Meldingens funksjon (OID=8279). Version information (version of the payload document) shold be given in the coding.version element.
The payload type describes the acceptable content that can be communicated on the endpoint.
Binding urn:oid:2.16.578.1.12.4.1.1.8279 (required) |
formatCode | | | Binding | There are no (further) constraints on this element Element idEndpoint.payloadType:formatCode Short description Specific information about payload type and version Definition no-basis: Specific information about payload type and version. Information about the payload type and version for ebxml and amqp messages
The payload type describes the acceptable content that can be communicated on the endpoint.
Binding urn:oid:2.16.578.1.12.4.1.1.0000 (required) |
payloadMimeType | | | Binding | There are no (further) constraints on this element Element idDefinition no-basis: should we list relevant codes for ebXML messages? List appropriate media types for FHIR REST endpoints?
XML: application/fhir+xml
JSON: application/fhir+json
RDF: application/fhir+turtle
ebXML messages: text/xml
The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
Binding http://www.rfc-editor.org/bcp/bcp13.txt (required) |
address | | | | There are no (further) constraints on this element Element idDefinition The uri that describes the actual end-point to connect to.
no-basis: for ebXML messages in Norway one is expected to use mailto: prefix for the endpoint.
For AMQP messages in Norway one is expected to use "ampq://" or "amqps://" prefix.
REST endpoints will have "http://" or "https://" prefix.
Examples amqp endpointamqp_endpoint
ebxml endpointebxml_endpoint
REST endpointREST_endpoint
|
no-basis-HealthCareService
Basisprofil for Norwegian Healthcare Service information. Defined by The Norwegian Directorate of eHealth and HL7 Norway. The profile adds Norwegian specific identification of Healthcare Services. The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.
Link to the full documentation of the profile no-basis-HealthcareService
Resource content
NoBasisHealthcareService (HealthcareService) | | | HealthcareService | There are no (further) constraints on this element Element idDefinition The details of a healthcare service available at a location. Should only be used for clinical healthcareservices offered by a PractitionerRole or by an Organization.
Data type HealthcareService |
identifier | | | | There are no (further) constraints on this element Element idHealthcareService.identifier |
providedBy | I | | Reference(Organization | no-basis-Organization) | There are no (further) constraints on this element Element idHealthcareService.providedBy Definition The organization that provides this healthcare service.
no-basis recommends the use of logical reference to an organization using ENH or RSH. To describe a top level organization. Departments within an organization could use a different reference scheme defined by the organization.
Data type Reference(Organization | no-basis-Organization) Constraints- no-basis-providedBy-identifier: no-basis recommends the use of logical references by ENH or RESH identifiers. If providedBy exists, identifiers should exist.
$this.exists(identifier.exists())
|
identifier | | | | There are no (further) constraints on this element Element idHealthcareService.providedBy.identifier Short description The logical reference of organization that provides this healthcare service. Definition no-basis recommends the use of logical reference to an organization using ENH or RSH. To describe a top level organization. Departments within an organization could use a different reference scheme defined by the organization.
no-basis recommends if an identifier is provided the identifier type or system should be provided.
|
system | I | | | There are no (further) constraints on this element Element idHealthcareService.providedBy.identifier.system Constraints- no-basis-identifier-system: no-basis recommends the use of urn:oid:2.16.578.1.12.4.1.4.101 (ENH) or urn:oid:2.16.578.1.12.4.1.4.102 (RESH) for identifier.system
$this.exists(value = 'urn:oid:2.16.578.1.12.4.1.4.101' or value = 'urn:oid:2.16.578.1.12.4.1.4.102')
|
category | | | | There are no (further) constraints on this element Element idHealthcareService.category Short description HealthcareService category Alternate names virksomhetstype Definition Example of category. Helsevirksomhet type (OID=9040), identifies the virksomhetstype used in Adresseregisteret. This element is usually not necessary to describe the HealthcareService adequately.
Binding urn:oid:2.16.578.1.12.4.1.1.9040 (example) |
type | | | | There are no (further) constraints on this element Element idDefinition no-basis: This element is usually not necessary to describe the HealthcareService adequately. Further coding can be used when common set of SNOMED codes are agreed for healthc care service types.
The specific type of service that may be delivered or performed.
|
specialty | | | | There are no (further) constraints on this element Element idHealthcareService.specialty Alternate names helsehjelpsområde Definition no-basis: Helsehjelpområde is given by the specialty element, preferred coding includes 8655 and 8654 codesystems. Type and category is usually not necessary to describe the HealthcareService adequately.
The specific type defined in a codesystem allowed included in the valueset.
|
coding | | | | There are no (further) constraints on this element Element idHealthcareService.specialty.coding Sliced: Unordered, Open, by system(Value) Two possible codings are given for the type element |
8655 | | | Binding | There are no (further) constraints on this element Element idHealthcareService.specialty.coding:8655 Short description Code describing the Helsehjelpområde Definition no-basis: Helsehjelpsområde (OID=8655) used to code the kind of clinical service the organization offers the patients through this HealthcareService
Also use Klinisk/medisinsk service (OID=8654)?
Binding urn:oid:2.16.578.1.12.4.1.1.8655 (preferred) |
system | | 1.. | Fixed Value | There are no (further) constraints on this element Element idHealthcareService.specialty.coding:8655.system Short description Identity of the 8655 codesystem Fixed value urn:oid:2.16.578.1.12.4.1.1.8655 |
code | | 1.. | | There are no (further) constraints on this element Element idHealthcareService.specialty.coding:8655.code |
8654 | | | Binding | There are no (further) constraints on this element Element idHealthcareService.specialty.coding:8654 Definition Klinisk/medisinsk service (OID=8654)
Binding Klinisk/medisinsk service
urn:oid:2.16.578.1.12.4.1.1.8654 (preferred) |
system | | 1.. | Fixed Value | There are no (further) constraints on this element Element idHealthcareService.specialty.coding:8654.system Fixed value urn:oid:2.16.578.1.12.4.1.1.8654 |
code | | 1.. | | There are no (further) constraints on this element Element idHealthcareService.specialty.coding:8654.code |
9151 | | | Binding | There are no (further) constraints on this element Element idHealthcareService.specialty.coding:9151 Definition IPLOS tjenestetype (OID=9151)
Binding urn:oid:2.16.578.1.12.4.1.1.9151 (preferred) |
system | | 1.. | Fixed Value | There are no (further) constraints on this element Element idHealthcareService.specialty.coding:9151.system Fixed value urn:oid:2.16.578.1.12.4.1.1.9151 |
code | | 1.. | | There are no (further) constraints on this element Element idHealthcareService.specialty.coding:9151.code |
8451 | | | Binding | There are no (further) constraints on this element Element idHealthcareService.specialty.coding:8451 Definition Binding urn:oid:2.16.578.1.12.4.1.1.8451 (preferred) |
system | | 1.. | Fixed Value | There are no (further) constraints on this element Element idHealthcareService.specialty.coding:8451.system Definition The identification of the Fagområde (OID=8451) code system.
Fixed value urn:oid:2.16.578.1.12.4.1.1.8451 |
code | | 1.. | | There are no (further) constraints on this element Element idHealthcareService.specialty.coding:8451.code |
location | | | Reference(Location | no-basis-Location) | There are no (further) constraints on this element Element idHealthcareService.location Data type Reference(Location | no-basis-Location) |
endpoint | | | Reference(Endpoint | no-basis-Endpoint) | There are no (further) constraints on this element Element idHealthcareService.endpoint Definition no-basis: In Norway endpoints for communication should be connected to a kommunikasjonspart-Organization identified with HERid and collected from the Norwegian Address register. Endpoints not registered in the Norwegian Address register can use other schemes of connecting endpoints to Organizations, PractitionerRole or HealthcareService.
Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
Data type Reference(Endpoint | no-basis-Endpoint) |
no-basis-Organization
Basisprofil for Norwegian Organization information. Defined by The Norwegian Directorate of eHealth and HL7 Norway. Should be used as a basis for further profiling in use-cases where specific identity information is needed. The basis profile is open, but derived profiles should restrict further the information elements according to specification relevant to the use-case.
The full documentation of the profile no-basis-Organization
Resource content
NoBasisOrganization (Organization) | | | Organization | There are no (further) constraints on this element Data type Organization |
identifier | | | | There are no (further) constraints on this element Element idSliced: Unordered, Open, by system(Value) |
ENH | | | | There are no (further) constraints on this element Element idOrganization.identifier:ENH Short description Organisasjonsnummer from Enhetsregisteret Alternate names organisasjonsnummer, organization number |
system | | 1.. | Fixed Value | There are no (further) constraints on this element Element idOrganization.identifier:ENH.system Fixed value urn:oid:2.16.578.1.12.4.1.4.101 |
value | | 1.. | | There are no (further) constraints on this element Element idOrganization.identifier:ENH.value |
RSH | | | | There are no (further) constraints on this element Element idOrganization.identifier:RSH Short description Nasjonalt register over enheter i spesialisthelsetjenesten (RESH-ID) |
system | | 1.. | Fixed Value | There are no (further) constraints on this element Element idOrganization.identifier:RSH.system Fixed value urn:oid:2.16.578.1.12.4.1.4.102 |
value | | 1.. | | There are no (further) constraints on this element Element idOrganization.identifier:RSH.value |
type | | | | There are no (further) constraints on this element Element idDefinition no-basis provides two commonly used slices to indicate Organization.type. Both ValueSets are used in the Norweian realm and is currently maintained at Volven.no:
- Organisatorisk nivå (OID=8628)
- Organisatorisk betegnelse (OID=8624)
The kind(s) of organization that this is.
Sliced: Unordered, Open, by coding.system(Value) |
organisatoriskNiva | | | Binding | There are no (further) constraints on this element Element idOrganization.type:organisatoriskNiva Short description Organisatorisk nivå Binding urn:oid:2.16.578.1.12.4.1.1.8628 (required) |
coding | | | | There are no (further) constraints on this element |
system | | 1.. | Fixed Value | There are no (further) constraints on this element Element idOrganization.type:organisatoriskNiva.coding.system Fixed value urn:oid:2.16.578.1.12.4.1.1.8628 |
code | | 1.. | | There are no (further) constraints on this element Element idOrganization.type:organisatoriskNiva.coding.code |
organisatoriskBetegnelse | | | Binding | There are no (further) constraints on this element Element idOrganization.type:organisatoriskBetegnelse Short description Organisatorisk betegnelse Binding urn:oid:2.16.578.1.12.4.1.1.8624 (required) |
coding | | | | There are no (further) constraints on this element |
system | | 1.. | Fixed Value | There are no (further) constraints on this element Element idOrganization.type:organisatoriskBetegnelse.coding.system Fixed value urn:oid:2.16.578.1.12.4.1.1.8624 |
code | | 1.. | | There are no (further) constraints on this element Element idOrganization.type:organisatoriskBetegnelse.coding.code |
address | | | no-basis-Address | There are no (further) constraints on this element Element idData type no-basis-Address |
partOf | | | Reference(Organization | no-basis-Organization) | There are no (further) constraints on this element Element idData type Reference(Organization | no-basis-Organization) |
contact | | | | There are no (further) constraints on this element |
address | | | no-basis-Address | There are no (further) constraints on this element Element idOrganization.contact.address Data type no-basis-Address |
endpoint | | | | There are no (further) constraints on this element Element idDefinition Technical endpoints providing access to services operated for the organization.
no-basis don't use this element to reference endpoints registered in the Norwegian Address register (endpoints connected to a kommunikasjonspart in tjenestebasert adressering). Endpoints registered in the Norwegian Address register should only be referenced through a kommunikasjonspart-Organization resource.
|
Example
Example organization resource conformant to no-basis-Organization profile:
Direktoratet for e-Helse
The HER-id and Organization
The HERid SHALL not be assigned on the Organizational level. The Organizations registered in adresseregisteret uses the HERid for message based addressing.
no-basis-Location
Basisprofil for Norwegian Location information. Defined by The Norwegian Directorate of eHealth and HL7 Norway. Should be used as a basis for further profiling in use-cases where specific location information is needed. The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.
The full documentation of the profile no-basis-Location
Resource content
NoBasisLocation (Location) | | | Location | There are no (further) constraints on this element Element idDefinition Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or
accommodated.
no-basis: The use-case for no-basis-Location is representation of organization structure to describe where a specific department or healthcare service is offered.
Data type Location |
address | | | no-basis-Address | There are no (further) constraints on this element Element idData type no-basis-Address |
managingOrganization | | | Reference(Organization | no-basis-Organization) | There are no (further) constraints on this element Element idLocation.managingOrganization Data type Reference(Organization | no-basis-Organization) Versioning rules: The reference must be version specific. |
endpoint | | | Reference(Endpoint | no-basis-Endpoint) | There are no (further) constraints on this element Element idDefinition no-basis don't use this element to reference endpoints registered in the Norwegian Address register (endpoints connected to a kommunikasjonspart in tjenestebasert adressering). Endpoints registered in the Norwegian Address register should only be referenced through a kommunikasjonspart-Organization resource.
Technical endpoints providing access to services operated for the location.
Data type Reference(Endpoint | no-basis-Endpoint) |
no-basis-DocumentReference
Basisprofil for Norwegian DocumentReference information. Defined by The Norwegian Directorate of eHealth and HL7 Norway. This profile identifies a set of minimum expectations for a DocumentReference resource when creating, searching and retrieving documents by defining which coding system(s) must be present when using this profile.
The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.
Link to the full documentation of the profile no-basis-DocumentReference
Resource content
NoBasisDocumentReference (DocumentReference) | | | DocumentReference | There are no (further) constraints on this element Data type DocumentReference |
type | | | Binding | There are no (further) constraints on this element Element idShort description Kind of document Definition Specifies the particular kind of document referenced using the codes defined in the valueset 'NoBasisDocumentReferenceType'.
Such as:
- A00-1 Epikriser og sammenfatninger
- A01-2 Kriseplan
- A02-2 Individuell plan
- etc.
See valueset 'NoBasisDocumentReferenceType' in the Terminology section for more information on available types
Comments Key metadata element describing the document that describes the exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.
Binding NoBasisDocumentReferenceType (required) |
no-basis-Composition
Basisprofil for Norwegian Composition information. Defined by The Norwegian Directorate of eHealth and HL7 Norway. This profile identifies a set of minimum expectations for a Composition resource when creating, searching and retrieving compositions by defining which coding system(s) must be present when using this profile.
The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.
Link to the full documentation of the profile no-basis-Composition
Resource content
NoBasisComposition (Composition) | | | Composition | There are no (further) constraints on this element Data type Composition |
type | | | Binding | There are no (further) constraints on this element Element idDefinition Specifies the particular kind of composition using the codes defined in the valueset 'NoBasisDocumentReferenceType'.
Such as:
- A00-1 Epikriser og sammenfatninger
- A01-2 Kriseplan
- A02-2 Individuell plan
- etc.
See valueset 'NoBasisDocumentReferenceType' in the Terminology section for more information on available types
Binding NoBasisDocumentReferenceType (required) |