Radiology (Sandbox)
0.0.1-current - ci-build International flag

Requirement Specification

This is for collaboration and discussion purposes and is subject to change.

This is not an Implementation Guide

Radiology (Sandbox) - Local Development build (v0.0.1-current) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: Radiological Accession Number

Official URL: https://fhir.nhs.uk/England/RAD/StructureDefinition/accession-number Version: 0.0.1-current
Draft as of 2024-10-24 Computable Name: AccessionNumber

Data Item Standard Data Type Value
RADIOLOGICAL ACCESSION NUMBER NHS Data Dictionary    
  DICOM (0008,0050) {value}
  HL7 FHIR Identifier.value {value}
  IHE XDS DocumentEntry.referenceIdList {value} using HL7 v2 CX format?
  HL7 v2 CX.1 {value}
Identifier type HL7 v2 CX.5 ACSN
  HL7 FHIR Identifier.type http://terminology.hl7.org/CodeSystem/v2-0203#ACSN
Assigning Facility HL7 v2 CX.6 ODS Code
  HL7 FHIR Identifier.assigner.identifier https://fhir.nhs.uk/Id/ods-organization-code#{ODS Code}

Usage:

Formal Views of Profile Content

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

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier Identifier
... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
... system 1..1 uri uri should be defined and unique supplying organisation.
... value 1..1 string The value that is unique

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..* Identifier An identifier intended for computation
... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ 0..1 CodeableConcept Description of identifier
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.


Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
... system Σ 1..1 uri uri should be defined and unique supplying organisation.
Example General: http://www.acme.com/identifiers/patient
... value Σ 1..1 string The value that is unique
Example General: 123456

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensiblePattern: ACSN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..* Identifier An identifier intended for computation
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ 0..1 CodeableConcept Description of identifier
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.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... system Σ 1..1 uri uri should be defined and unique supplying organisation.
Example General: http://www.acme.com/identifiers/patient
... value Σ 1..1 string The value that is unique
Example General: 123456
... period Σ 0..1 Period Time period when id is/was valid for use
... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensiblePattern: ACSN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

This structure is derived from Identifier

Summary

Mandatory: 2 elements

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier Identifier
... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
... system 1..1 uri uri should be defined and unique supplying organisation.
... value 1..1 string The value that is unique

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..* Identifier An identifier intended for computation
... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ 0..1 CodeableConcept Description of identifier
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.


Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
... system Σ 1..1 uri uri should be defined and unique supplying organisation.
Example General: http://www.acme.com/identifiers/patient
... value Σ 1..1 string The value that is unique
Example General: 123456

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensiblePattern: ACSN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..* Identifier An identifier intended for computation
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ 0..1 CodeableConcept Description of identifier
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.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... system Σ 1..1 uri uri should be defined and unique supplying organisation.
Example General: http://www.acme.com/identifiers/patient
... value Σ 1..1 string The value that is unique
Example General: 123456
... period Σ 0..1 Period Time period when id is/was valid for use
... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensiblePattern: ACSN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

This structure is derived from Identifier

Summary

Mandatory: 2 elements

 

Other representations of profile: CSV, Excel, Schematron