eRS-DocumentReference-1

DocumentReference.status

current | superseded | entered-in-error

code

The status of the document reference.

DocumentReferenceStatus (required)

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: TXA-19
• rim: interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"
• xds: DocumentEntry status
• w5: status

DocumentReference.type.coding.system

Identity of the terminology system

uri

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

https://fhir.nhs.uk/STU3/CodeSystem/eRS-AttachmentType-1

• rim: n/a
• v2: C*E.3
• rim: ./codeSystem
• orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

DocumentReference.type.coding.code

Symbol in syntax defined by the system

code

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

REFERRER

• rim: n/a
• v2: C*E.1
• rim: ./code
• orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

DocumentReference.type.coding.display

Representation defined by the system

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

Referrer

• rim: n/a
• v2: C*E.2 - but note this is not well followed
• rim: CV.displayName
• orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

DocumentReference.indexed

When this document reference was created

instant

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

2016-09-05T13:24:53+00:00

• rim: n/a
• rim: .availabilityTime[type="TS"]
• xds: DocumentEntry.submissionTime
• w5: when.recorded

DocumentReference.description

Human-readable description (title)

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: TXA-25
• rim: .outboundRelationship[typeCode="SUBJ"].target.text
• xds: DocumentEntry.description

DocumentReference.content.attachment.extension:attachedBy

Optional Extensions Element

extensions, user content

Extension(Reference(eRS-Practitioner-1))

https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AttachedBy-1

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())
• ext-1: Must have either extensions or value[x], not both
  extension.exists() != value.exists()

• rim: n/a
• rim: N/A

DocumentReference.content.attachment.extension:availabilityStatus

Optional Extensions Element

extensions, user content

Extension(Coding)

https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AvailabilityStatus-1

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())
• ext-1: Must have either extensions or value[x], not both
  extension.exists() != value.exists()

• rim: n/a
• rim: N/A

DocumentReference.content.attachment.extension:attachedByOrganisation

Optional Extensions Element

extensions, user content

Extension(Reference)

https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AttachedByOrganisation-1

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())
• ext-1: Must have either extensions or value[x], not both
  extension.exists() != value.exists()

• rim: n/a
• rim: N/A

DocumentReference.content.attachment.extension:attachedOnBehalfOf

Optional Extensions Element

extensions, user content

Extension(Reference(eRS-Practitioner-1))

https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AttachedOnBehalfOf-1

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())
• ext-1: Must have either extensions or value[x], not both
  extension.exists() != value.exists()

• rim: n/a
• rim: N/A

DocumentReference.content.attachment.contentType

Mime type of the content, with charset etc.

code

The mime type of an attachment. Any valid mime type is allowed.

http://www.rfc-editor.org/bcp/bcp13.txt (required)

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

text/plain; charset=UTF-8, image/png

• rim: n/a
• v2: ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
• rim: ./mediaType, ./charset

DocumentReference.content.attachment.url

Uri where the data can be found

uri

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

http://www.acme.com/logo-small.png

• rim: n/a
• v2: RP.1+RP.2 - if they refer to a URL (see v2.6)
• rim: ./reference/literal

DocumentReference.content.attachment.size

Number of bytes of content (if url provided)

unsignedInt

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• rim: N/A (needs data type R3 proposal)

DocumentReference.content.attachment.title

Label to display in place of the data

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

Official Corporate Logo

• rim: n/a
• rim: ./title/data

DocumentReference.content.attachment.creation

Date attachment was first created

dateTime

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• rim: N/A (needs data type R3 proposal)