SFM Basis API Implementation Guide

Patient.extension:citizenship.extension:code.url

identifies the meaning of the extension

uri

code

• rim: N/A

Address

Age

Annotation

Attachment

base64Binary

boolean

canonical

code

Coding

ContactDetail

ContactPoint

Contributor

Count

DataRequirement

date

dateTime

decimal

Distance

Dosage

Duration

Expression

HumanName

id

Identifier

instant

integer

markdown

Money

oid

ParameterDefinition

Period

positiveInt

Quantity

Range

Ratio

Reference

RelatedArtifact

SampledData

Signature

string

time

Timing

TriggerDefinition

unsignedInt

uri

url

UsageContext

uuid

Patient.extension:citizenship.extension:code.value[x]:valueCodeableConcept

Value of extension

CodeableConcept

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() or (children().count() > id.count())

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

Patient.extension:citizenship.extension:period.url

identifies the meaning of the extension

uri

period

• rim: N/A

Address

Age

Annotation

Attachment

base64Binary

boolean

canonical

code

CodeableConcept

Coding

ContactDetail

ContactPoint

Contributor

Count

DataRequirement

date

dateTime

decimal

Distance

Dosage

Duration

Expression

HumanName

id

Identifier

instant

integer

markdown

Money

oid

ParameterDefinition

positiveInt

Quantity

Range

Ratio

Reference

RelatedArtifact

SampledData

Signature

string

time

Timing

TriggerDefinition

unsignedInt

uri

url

UsageContext

uuid

Patient.extension:citizenship.extension:period.value[x]:valuePeriod

Value of extension

Period

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() or (children().count() > id.count())

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

Patient.extension:citizenship.url

identifies the meaning of the extension

uri

http://hl7.org/fhir/StructureDefinition/patient-citizenship

• rim: N/A

Patient.identifier:FNR.use

usual | official | temp | secondary | old (If known)

code

IdentifierUse (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() or (children().count() > id.count())

• rim: n/a
• v2: N/A
• rim: Role.code or implied by context

Patient.identifier:FNR.type

Description of identifier

CodeableConcept

Identifier Type Codes (extensible)

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() or (children().count() > id.count())

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• v2: CX.5
• rim: Role.code or implied by context

Patient.identifier:FNR.system

Identification of the Norwegian FNR

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() or (children().count() > id.count())

urn:oid:2.16.578.1.12.4.1.4.1

http://www.acme.com/identifiers/patient

• rim: n/a
• v2: CX.4 / EI-2-4
• rim: II.root or Role.id.root
• servd: ./IdentifierType

Patient.identifier:FNR.value

The actual Fødselsnummer

Fødselsnummer

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() or (children().count() > id.count())

123456

13057444850

• rim: n/a
• v2: CX.1 / EI.1
• rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
• servd: ./Value

Patient.identifier:FNR.period

Time period when id is/was valid for use

Period

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() or (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.hasValue().not() or end.hasValue().not() or (start <= end)

• rim: n/a
• v2: DR
• rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
• v2: CX.7 + CX.8
• rim: Role.effectiveTime or implied by context
• servd: ./StartDate and ./EndDate

Patient.identifier:FNR.assigner

Organization that issued id (may be just text)

Reference(Organization)

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() or (children().count() > id.count())
• ref-1: SHALL have a contained resource if a local reference is provided
  reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• v2: CX.4 / (CX.4,CX.9,CX.10)
• rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
• servd: ./IdentifierIssuingAuthority

Patient.identifier:DNR.use

usual | official | temp | secondary | old (If known)

code

IdentifierUse (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() or (children().count() > id.count())

• rim: n/a
• v2: N/A
• rim: Role.code or implied by context

Patient.identifier:DNR.type

Description of identifier

CodeableConcept

Identifier Type Codes (extensible)

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() or (children().count() > id.count())

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• v2: CX.5
• rim: Role.code or implied by context

Patient.identifier:DNR.system

The identification of the D-nummer

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() or (children().count() > id.count())

urn:oid:2.16.578.1.12.4.1.4.2

http://www.acme.com/identifiers/patient

• rim: n/a
• v2: CX.4 / EI-2-4
• rim: II.root or Role.id.root
• servd: ./IdentifierType

Patient.identifier:DNR.value

The actual D-nummer

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() or (children().count() > id.count())

123456

• rim: n/a
• v2: CX.1 / EI.1
• rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
• servd: ./Value

Patient.identifier:DNR.period

Time period when id is/was valid for use

Period

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() or (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.hasValue().not() or end.hasValue().not() or (start <= end)

• rim: n/a
• v2: DR
• rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
• v2: CX.7 + CX.8
• rim: Role.effectiveTime or implied by context
• servd: ./StartDate and ./EndDate

Patient.identifier:DNR.assigner

Organization that issued id (may be just text)

Reference(Organization)

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() or (children().count() > id.count())
• ref-1: SHALL have a contained resource if a local reference is provided
  reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• v2: CX.4 / (CX.4,CX.9,CX.10)
• rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
• servd: ./IdentifierIssuingAuthority

Patient.identifier:xxxid.use

usual | official | temp | secondary | old (If known)

code

IdentifierUse (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() or (children().count() > id.count())

• rim: n/a
• v2: N/A
• rim: Role.code or implied by context

Patient.identifier:xxxid.type

Description of identifier

CodeableConcept

Identifier Type Codes (extensible)

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() or (children().count() > id.count())

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• v2: CX.5
• rim: Role.code or implied by context

Patient.identifier:xxxid.period

Time period when id is/was valid for use

Period

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() or (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.hasValue().not() or end.hasValue().not() or (start <= end)

• rim: n/a
• v2: DR
• rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
• v2: CX.7 + CX.8
• rim: Role.effectiveTime or implied by context
• servd: ./StartDate and ./EndDate

Patient.identifier:xxxid.assigner

Organization that issued id (may be just text)

Reference(Organization)

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() or (children().count() > id.count())
• ref-1: SHALL have a contained resource if a local reference is provided
  reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• v2: CX.4 / (CX.4,CX.9,CX.10)
• rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
• servd: ./IdentifierIssuingAuthority

Patient.name.use

usual | official | temp | nickname | anonymous | old | maiden

code

NameUse (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() or (children().count() > id.count())

• rim: n/a
• v2: XPN.7, but often indicated by which field contains the name
• rim: unique(./use)
• servd: ./NamePurpose

Patient.name.text

Text representation of the full name

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() or (children().count() > id.count())

• rim: n/a
• v2: implied by XPN.11
• rim: ./formatted

Patient.name.family

Family name (often called 'Surname')

surname, etternavn

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() or (children().count() > id.count())

• rim: n/a
• v2: XPN.1/FN.1
• rim: ./part[partType = FAM]
• servd: ./FamilyName

Patient.name.given

Given names (not always 'first')

first name, middle name, fornavn

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() or (children().count() > id.count())

• rim: n/a
• v2: XPN.2 + XPN.3
• rim: ./part[partType = GIV]
• servd: ./GivenNames

Patient.name.prefix

Prefix is not used in Norwegian names

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() or (children().count() > id.count())

• rim: n/a
• v2: XPN.5
• rim: ./part[partType = PFX]
• servd: ./TitleCode

Patient.name.suffix

Suffix is not used in Norwegian human names

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() or (children().count() > id.count())

• rim: n/a
• v2: XPN/4
• rim: ./part[partType = SFX]

Patient.name.period

Time period when name was/is in use

Period

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() or (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.hasValue().not() or end.hasValue().not() or (start <= end)

• rim: n/a
• v2: DR
• rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
• v2: XPN.13 + XPN.14
• rim: ./usablePeriod[type="IVL<TS>"]
• servd: ./StartDate and ./EndDate

boolean

dateTime

Patient.address.extension:urbanDistrict

urban district information

extensions, user content, bydel, urban district

Extension(Coding)

http://hl7.no/fhir/StructureDefinition/no-basis-urban-district

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() or (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

Patient.address.extension:propertyInformation

Real property identification

extensions, user content

Extension(Complex)

http://hl7.no/fhir/StructureDefinition/no-basis-propertyinformation

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() or (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

Patient.address.use

home | work | temp | old | billing - purpose of this address

code

AddressUse (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() or (children().count() > id.count())

home

• rim: n/a
• v2: XAD.7
• rim: unique(./use)
• servd: ./AddressPurpose

Patient.address.type

postal | physical | both

code

AddressType (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() or (children().count() > id.count())

both

• rim: n/a
• v2: XAD.18
• rim: unique(./use)
• vcard: address type parameter

Patient.address.text

Text representation of the address

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() or (children().count() > id.count())

137 Nowhere Street, Erewhon 9132

• rim: n/a
• v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
• rim: ./formatted
• vcard: address label parameter

Patient.address.line

Street name, number, direction & P.O. Box etc.

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() or (children().count() > id.count())

137 Nowhere Street

• rim: n/a
• v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
• rim: AD.part[parttype = AL]
• vcard: street
• servd: ./StreetAddress (newline delimitted)

Patient.address.city

Poststed or city

Municpality, by, poststed

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() or (children().count() > id.count())

Erewhon

• rim: n/a
• v2: XAD.3
• rim: AD.part[parttype = CTY]
• vcard: locality
• servd: ./Jurisdiction

Patient.address.district

name of "kommune"

County, kommune

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() or (children().count() > id.count())

Madison

• rim: n/a
• v2: XAD.9
• rim: AD.part[parttype = CNT | CPA]

Patient.address.state

norwegian "fylke"

Province, Territory, fylke

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() or (children().count() > id.count())

• rim: n/a
• v2: XAD.4
• rim: AD.part[parttype = STA]
• vcard: region
• servd: ./Region

Patient.address.postalCode

Postal code for area

Zip, postnummer

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() or (children().count() > id.count())

9132

• rim: n/a
• v2: XAD.5
• rim: AD.part[parttype = ZIP]
• vcard: code
• servd: ./PostalIdentificationCode

Patient.address.country

Country (e.g. can be ISO 3166 2 or 3 letter code)

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() or (children().count() > id.count())

• rim: n/a
• v2: XAD.6
• rim: AD.part[parttype = CNT]
• vcard: country
• servd: ./Country

Patient.address.period

Time period when address was/is in use

Period

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() or (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.hasValue().not() or end.hasValue().not() or (start <= end)

{
  "start": "2010-03-23",
  "end": "2010-07-01"
}

• rim: n/a
• v2: DR
• rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
• v2: XAD.12 / XAD.13 + XAD.14
• rim: ./usablePeriod[type="IVL<TS>"]
• servd: ./StartDate and ./EndDate

Patient.maritalStatus

Marital (civil) status of a patient

CodeableConcept

Marital Status Codes (extensible)

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() or (children().count() > id.count())

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• v2: PID-16
• rim: player[classCode=PSN]/maritalStatusCode
• cda: .patient.maritalStatusCode

boolean

integer

Patient.photo

Image of the patient

Attachment

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() or (children().count() > id.count())
• att-1: If the Attachment has data, it SHALL have a contentType
  data.empty() or contentType.exists()

• rim: n/a
• v2: ED/RP
• rim: ED
• v2: OBX-5 - needs a profile
• rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
• cda: n/a

Patient.contact.relationship

The kind of relationship

CodeableConcept

PatientContactRelationship (extensible)

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() or (children().count() > id.count())

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• v2: NK1-7, NK1-3
• rim: code
• cda: n/a

Patient.contact.name

Norwegian human name

NoBasisHumanName

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() or (children().count() > id.count())

• rim: n/a
• v2: XPN
• rim: EN (actually, PN)
• servd: ProviderName
• v2: NK1-2
• rim: name
• cda: n/a

Patient.contact.telecom

A contact detail for the person

ContactPoint

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() or (children().count() > id.count())
• cpt-2: A system is required if a value is provided.
  value.empty() or system.exists()