MyHealtheVet PHR FHIR API
0.3.9-current - ci-build
MyHealtheVet PHR FHIR API
0.3.9-current - ci-build
MyHealtheVet PHR FHIR API, published by VA Digital Services. This guide is not an authorized publication; it is the continuous build for version 0.3.9-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/department-of-veterans-affairs/mhv-fhir-phr-mapping/ and changes regularly. See the Directory of published versions
| Official URL: https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.LabSpecimen | Version: 0.3.9-current | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: MHVlabSpecimen | ||
A profile showing how the Microbiology and Pathology LabSpecimenTO is mapped into a FHIR Specimen.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Specimen |
0..* | Specimen | Sample for analysis | |
  Slices for identifier |
S | 0..1 | Identifier | External Identifier Slice: Unordered, Open by pattern:use |
   identifier:TOid |
0..1 | Identifier | External Identifier | |
   use |
1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
| system |
C | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} |
 value |
0..1 | string | `LabSpecimenTO` | `.` | {LabSpecimenTO.id} | |
| accessionIdentifier |
S | 0..1 | Identifier | Identifier assigned by the lab |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
| 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 |
C | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} |
| value |
0..1 | string | `Accession` | `.` | {LabSpecimenTO.accessionNum} | |
| status |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error | |
| type |
S | 0..1 | CodeableConcept | Kind of material that forms the specimen |
| text |
1..1 | string | Plain text representation of the concept | |
| subject |
0..0 | |||
| receivedTime |
0..0 | |||
| parent |
0..0 | |||
| request |
0..0 | |||
| collection |
S | 0..1 | BackboneElement | Collection details |
| collector |
0..0 | |||
| Slices for collected[x] |
0..1 | dateTime, Period | Collection time Slice: Unordered, Open by type:$this | |
| collected[x]:collectedDateTime |
S | 0..1 | dateTime | Collection time |
| duration |
0..0 | |||
| quantity |
0..0 | |||
| method |
0..0 | |||
| bodySite |
S | 0..1 | CodeableConcept | Anatomical collection site |
| text |
0..1 | string | Plain text representation of the concept | |
| fastingStatus[x] |
0..0 | |||
| processing |
0..0 | |||
| container |
0..0 | |||
| condition |
0..0 | |||
| note |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| TOid-startswithoid | error | Specimen.identifier:TOid.system, Specimen.accessionIdentifier.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
SΣ | 0..1 | Identifier | External Identifier Slice: Unordered, Open by pattern:use |
| identifier:TOid |
Σ | 0..1 | Identifier | External Identifier |
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual |
| system |
ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 0..1 | string | `LabSpecimenTO` | `.` | {LabSpecimenTO.id} Example General: 123456 |
 accessionIdentifier |
SΣ | 0..1 | Identifier | Identifier assigned by the lab |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual |
| 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 |
ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 0..1 | string | `Accession` | `.` | {LabSpecimenTO.accessionNum} Example General: 123456 |
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
| type |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. |
| text |
Σ | 1..1 | string | Plain text representation of the concept |
| collection |
S | 0..1 | BackboneElement | Collection details |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Slices for collected[x] |
Σ | 0..1 | Collection time Slice: Unordered, Open by type:$this | |
 collectedDateTime |
dateTime | |||
| collectedPeriod |
Period | |||
| collected[x]:collectedDateTime |
SΣ | 0..1 | dateTime | Collection time |
| bodySite |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Specimen.identifier:TOid.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Specimen.accessionIdentifier.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Specimen.accessionIdentifier.type | extensible | Pattern: ACSNhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1from the FHIR Standard | |
| Specimen.type | example | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | |
| Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| TOid-startswithoid | error | Specimen.identifier:TOid.system, Specimen.accessionIdentifier.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 0..1 | Identifier | External Identifier Slice: Unordered, Open by pattern:use | ||||
| identifier:TOid |
Σ | 0..1 | Identifier | External Identifier | ||||
| 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 |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
| 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. | ||||
| system |
ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | `LabSpecimenTO` | `.` | {LabSpecimenTO.id} 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) | ||||
| accessionIdentifier |
SΣ | 0..1 | Identifier | Identifier assigned by the lab | ||||
| 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 . Required Pattern: usual | ||||
| 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 |
ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | `Accession` | `.` | {LabSpecimenTO.accessionNum} 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) | ||||
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
| type |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||
| collection |
S | 0..1 | BackboneElement | Collection details | ||||
| 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 | ||||
| Slices for collected[x] |
Σ | 0..1 | Collection time Slice: Unordered, Open by type:$this | |||||
| collectedDateTime |
dateTime | |||||||
| collectedPeriod |
Period | |||||||
| collected[x]:collectedDateTime |
SΣ | 0..1 | dateTime | Collection time | ||||
| bodySite |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Specimen.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Specimen.identifier:TOid.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Specimen.identifier:TOid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Specimen.accessionIdentifier.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Specimen.accessionIdentifier.type | extensible | Pattern: ACSNhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1from the FHIR Standard | ||||
| Specimen.type | example | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | ||||
| Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedurefrom the FHIR Standard | ||||
| Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-typefrom the FHIR Standard | ||||
| Specimen.container.additive[x] | example | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 |
| Id | Grade | Path(s) | Details | Requirements |
| TOid-startswithoid | error | Specimen.identifier:TOid.system, Specimen.accessionIdentifier.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
This structure is derived from Specimen
Summary
Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 6 elements
Prohibited: 13 elements
Slices
This structure defines the following Slices:
Maturity: 1
Differential View
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |
| Slices for identifier |
S | 0..1 | Identifier | External Identifier Slice: Unordered, Open by pattern:use |
| identifier:TOid |
0..1 | Identifier | External Identifier | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
| system |
C | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} |
| value |
0..1 | string | `LabSpecimenTO` | `.` | {LabSpecimenTO.id} | |
| accessionIdentifier |
S | 0..1 | Identifier | Identifier assigned by the lab |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
| 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 |
C | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} |
| value |
0..1 | string | `Accession` | `.` | {LabSpecimenTO.accessionNum} | |
| status |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error | |
| type |
S | 0..1 | CodeableConcept | Kind of material that forms the specimen |
| text |
1..1 | string | Plain text representation of the concept | |
| subject |
0..0 | |||
| receivedTime |
0..0 | |||
| parent |
0..0 | |||
| request |
0..0 | |||
| collection |
S | 0..1 | BackboneElement | Collection details |
| collector |
0..0 | |||
| Slices for collected[x] |
0..1 | dateTime, Period | Collection time Slice: Unordered, Open by type:$this | |
| collected[x]:collectedDateTime |
S | 0..1 | dateTime | Collection time |
| duration |
0..0 | |||
| quantity |
0..0 | |||
| method |
0..0 | |||
| bodySite |
S | 0..1 | CodeableConcept | Anatomical collection site |
| text |
0..1 | string | Plain text representation of the concept | |
| fastingStatus[x] |
0..0 | |||
| processing |
0..0 | |||
| container |
0..0 | |||
| condition |
0..0 | |||
| note |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| TOid-startswithoid | error | Specimen.identifier:TOid.system, Specimen.accessionIdentifier.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
SΣ | 0..1 | Identifier | External Identifier Slice: Unordered, Open by pattern:use |
| identifier:TOid |
Σ | 0..1 | Identifier | External Identifier |
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual |
| system |
ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 0..1 | string | `LabSpecimenTO` | `.` | {LabSpecimenTO.id} Example General: 123456 |
| accessionIdentifier |
SΣ | 0..1 | Identifier | Identifier assigned by the lab |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual |
| 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 |
ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 0..1 | string | `Accession` | `.` | {LabSpecimenTO.accessionNum} Example General: 123456 |
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
| type |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. |
| text |
Σ | 1..1 | string | Plain text representation of the concept |
| collection |
S | 0..1 | BackboneElement | Collection details |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Slices for collected[x] |
Σ | 0..1 | Collection time Slice: Unordered, Open by type:$this | |
| collectedDateTime |
dateTime | |||
| collectedPeriod |
Period | |||
| collected[x]:collectedDateTime |
SΣ | 0..1 | dateTime | Collection time |
| bodySite |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Specimen.identifier:TOid.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Specimen.accessionIdentifier.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Specimen.accessionIdentifier.type | extensible | Pattern: ACSNhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1from the FHIR Standard | |
| Specimen.type | example | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | |
| Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| TOid-startswithoid | error | Specimen.identifier:TOid.system, Specimen.accessionIdentifier.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 0..1 | Identifier | External Identifier Slice: Unordered, Open by pattern:use | ||||
| identifier:TOid |
Σ | 0..1 | Identifier | External Identifier | ||||
| 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 |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
| 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. | ||||
| system |
ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | `LabSpecimenTO` | `.` | {LabSpecimenTO.id} 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) | ||||
| accessionIdentifier |
SΣ | 0..1 | Identifier | Identifier assigned by the lab | ||||
| 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 . Required Pattern: usual | ||||
| 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 |
ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | `Accession` | `.` | {LabSpecimenTO.accessionNum} 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) | ||||
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
| type |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||
| collection |
S | 0..1 | BackboneElement | Collection details | ||||
| 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 | ||||
| Slices for collected[x] |
Σ | 0..1 | Collection time Slice: Unordered, Open by type:$this | |||||
| collectedDateTime |
dateTime | |||||||
| collectedPeriod |
Period | |||||||
| collected[x]:collectedDateTime |
SΣ | 0..1 | dateTime | Collection time | ||||
| bodySite |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Specimen.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Specimen.identifier:TOid.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Specimen.identifier:TOid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Specimen.accessionIdentifier.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Specimen.accessionIdentifier.type | extensible | Pattern: ACSNhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1from the FHIR Standard | ||||
| Specimen.type | example | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | ||||
| Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedurefrom the FHIR Standard | ||||
| Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-typefrom the FHIR Standard | ||||
| Specimen.container.additive[x] | example | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 |
| Id | Grade | Path(s) | Details | Requirements |
| TOid-startswithoid | error | Specimen.identifier:TOid.system, Specimen.accessionIdentifier.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
This structure is derived from Specimen
Summary
Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 6 elements
Prohibited: 13 elements
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron