Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Resource Profile: AthenaNamingSystem

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-namingsystem-profile Version: 23.1.0
Active as of 2022-03-01 Computable Name: AthenaNamingSystem

Defines constraints and extensions on the Binary resource as supported by Athena Products.

This NamingSystem profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access NamingSystem resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The NamingSystem resource provides information about identifier systems used by the API Server to translate between athenaPractice and athenaFlow specific coding and identifier systems to standard values used in HL7 FHIR Resources. The content is derived from an external file created during system installation.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from NamingSystem

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem 0..* NamingSystem System of unique identification
... id 1..1 id Logical id of this artifact
... name 1..1 string Name for this naming system (computer friendly)
... status 1..1 code draft | active | retired | unknown
... uniqueId 1..* BackboneElement Unique identifiers used for system
.... type 1..1 code oid | uuid | uri | other
.... value 1..1 string The unique identifier
.... preferred 0..1 boolean Is this the id that should be used for this type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem C 0..* NamingSystem System of unique identification
nsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
nsd-1: Root systems cannot have uuid identifiers
nsd-2: Can't have more than one preferred identifier for a type
... id Σ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... kind Σ 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.

... date Σ 1..1 dateTime Date last changed
... uniqueId Σ 1..* BackboneElement Unique identifiers used for system
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 1..1 code oid | uuid | uri | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.

.... value Σ 1..1 string The unique identifier
.... preferred 0..1 boolean Is this the id that should be used for this type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
NamingSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
NamingSystem.kindrequiredNamingSystemType
http://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1
from the FHIR Standard
NamingSystem.uniqueId.typerequiredNamingSystemIdentifierType
http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem C 0..* NamingSystem System of unique identification
nsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
nsd-1: Root systems cannot have uuid identifiers
nsd-2: Can't have more than one preferred identifier for a type
... id Σ 1..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
... 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
... name ΣC 1..1 string Name for this naming system (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... kind Σ 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.

... date Σ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... responsible 0..1 string Who maintains system namespace?
... type 0..1 CodeableConcept e.g. driver, provider, patient, bank etc.
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

... description 0..1 markdown Natural language description of the naming system
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... usage 0..1 string How/where is it used
... uniqueId Σ 1..* BackboneElement Unique identifiers used for system
.... 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
.... type Σ 1..1 code oid | uuid | uri | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.

.... value Σ 1..1 string The unique identifier
.... preferred 0..1 boolean Is this the id that should be used for this type
.... comment 0..1 string Notes about identifier usage
.... period 0..1 Period When is identifier valid?

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
NamingSystem.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
NamingSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
NamingSystem.kindrequiredNamingSystemType
http://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1
from the FHIR Standard
NamingSystem.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
NamingSystem.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
NamingSystem.uniqueId.typerequiredNamingSystemIdentifierType
http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1
from the FHIR Standard

This structure is derived from NamingSystem

Summary

Mandatory: 7 elements

Differential View

This structure is derived from NamingSystem

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem 0..* NamingSystem System of unique identification
... id 1..1 id Logical id of this artifact
... name 1..1 string Name for this naming system (computer friendly)
... status 1..1 code draft | active | retired | unknown
... uniqueId 1..* BackboneElement Unique identifiers used for system
.... type 1..1 code oid | uuid | uri | other
.... value 1..1 string The unique identifier
.... preferred 0..1 boolean Is this the id that should be used for this type

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem C 0..* NamingSystem System of unique identification
nsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
nsd-1: Root systems cannot have uuid identifiers
nsd-2: Can't have more than one preferred identifier for a type
... id Σ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... kind Σ 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.

... date Σ 1..1 dateTime Date last changed
... uniqueId Σ 1..* BackboneElement Unique identifiers used for system
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 1..1 code oid | uuid | uri | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.

.... value Σ 1..1 string The unique identifier
.... preferred 0..1 boolean Is this the id that should be used for this type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
NamingSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
NamingSystem.kindrequiredNamingSystemType
http://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1
from the FHIR Standard
NamingSystem.uniqueId.typerequiredNamingSystemIdentifierType
http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem C 0..* NamingSystem System of unique identification
nsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
nsd-1: Root systems cannot have uuid identifiers
nsd-2: Can't have more than one preferred identifier for a type
... id Σ 1..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
... 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
... name ΣC 1..1 string Name for this naming system (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... kind Σ 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.

... date Σ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... responsible 0..1 string Who maintains system namespace?
... type 0..1 CodeableConcept e.g. driver, provider, patient, bank etc.
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

... description 0..1 markdown Natural language description of the naming system
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... usage 0..1 string How/where is it used
... uniqueId Σ 1..* BackboneElement Unique identifiers used for system
.... 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
.... type Σ 1..1 code oid | uuid | uri | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.

.... value Σ 1..1 string The unique identifier
.... preferred 0..1 boolean Is this the id that should be used for this type
.... comment 0..1 string Notes about identifier usage
.... period 0..1 Period When is identifier valid?

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
NamingSystem.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
NamingSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
NamingSystem.kindrequiredNamingSystemType
http://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1
from the FHIR Standard
NamingSystem.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
NamingSystem.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
NamingSystem.uniqueId.typerequiredNamingSystemIdentifierType
http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1
from the FHIR Standard

This structure is derived from NamingSystem

Summary

Mandatory: 7 elements

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

The Interactions supported by this resource are listed below.

Search Parameters

Search Parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for NamingSystem resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/R4/NamingSystem?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer
[_count] Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results NamingSystem resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Virence Partner program. Note: The Centricity API Server support the HL7 FHIR Paging capability.
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token) The ID of the resource
name (token) Human-readable label
value (string) The unique identifier
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.