Common FHIR profile vendor collaboration
1.0.1 - update
Common FHIR profile vendor collaboration
1.0.1 - update
This page is part of the Common FHIR profile vendor collaboration (v1.0.1: Release) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Official URL: https://commonprofiles.care/fhir/StructureDefinition/PatientSEVendorLite | Version: 1.0.1 | |||
| Active as of 2023-06-12 | Computable Name: PatientSEVendorLite | |||
Simplified patient for identification for communication between systems in Sweden
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SEBasePatient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | 0..* | SEBasePatient | Information about an individual or animal receiving health care services | |
  identifier | S | 1..* | Identifier | An identifier for this patient |
  identifier:personnummer | S | 0..1 | Identifier | An identifier for this patient |
  value | C | 1..1 | string | The value that is unique personnummer-invariant: All identifiers that identifies as personnummer SHALL comply with the specified regex: ^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-2]\d|3[0-1])\d{4} Example General: 191212121212 |
| identifier:samordningsnummer | S | 0..1 | Identifier | An identifier for this patient |
| value | C | 1..1 | string | The value that is unique samordningsnummer-invariant: All identifiers that identifies as samordningsnummer SHALL comply with the specified regex: ^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-8]\d|9[0-1])\d{4} Example General: 197010632391 |
| identifier:nationelltReservnummer | S | 0..1 | Identifier | An identifier for this patient |
| value | 1..1 | string | The value that is unique | |
| active | 0..0 | |||
| name | S | 0..1 | SEBaseHumanName | Name of a human - parts and usage |
| use | 0..0 | |||
 period | 0..0 | |||
| telecom | ||||
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
| value | S | 1..1 | string | The actual contact point details |
| period | 0..0 | |||
 deceased[x] | S | 0..1 | boolean | Indicates if the individual is deceased or not |
| address | 0..0 | |||
| maritalStatus | 0..0 | |||
| multipleBirth[x] | 0..0 | |||
| photo | 0..0 | |||
| contact | 0..0 | |||
| communication | 0..0 | |||
| generalPractitioner | 0..0 | |||
| managingOrganization | 0..0 | |||
| link | 0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| personnummer-invariant | error | Patient.identifier:personnummer.value | All identifiers that identifies as personnummer SHALL comply with the specified regex:
^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-2]\d|3[0-1])\d{4} : $this.toString().matches('^(18|19|[2-9]\\d)\\d{2}(0[1-9]|1[012])([0-2]\\d|3[0-1])\\d{4}') | |
| samordningsnummer-invariant | error | Patient.identifier:samordningsnummer.value | All identifiers that identifies as samordningsnummer SHALL comply with the specified regex:
^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-8]\d|9[0-1])\d{4} : $this.toString().matches('^(18|19|[2-9]\\d)\\d{2}(0[1-9]|1[012])([0-8]\\d|9[0-1])\\d{4}') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | SEBasePatient | Information about an individual or animal receiving health care services | |
| 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Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
 identifier:personnummer | SΣ | 0..1 | Identifier | An identifier for this patient |
  use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/personnummer |
| value | ΣC | 1..1 | string | The value that is unique personnummer-invariant: All identifiers that identifies as personnummer SHALL comply with the specified regex: ^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-2]\d|3[0-1])\d{4} Example General: 123456 Example General: 191212121212 |
| identifier:samordningsnummer | SΣ | 0..1 | Identifier | An identifier for this patient |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/samordningsnummer |
| value | ΣC | 1..1 | string | The value that is unique samordningsnummer-invariant: All identifiers that identifies as samordningsnummer SHALL comply with the specified regex: ^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-8]\d|9[0-1])\d{4} Example General: 123456 Example General: 197010632391 |
 identifier:nationelltReservnummer | SΣ | 0..1 | Identifier | An identifier for this patient |
 use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/nationelltReservnumer |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
 name | S | 0..1 | SEBaseHumanName | Name of a human - parts and usage |
| middleName | 0..1 | string | SE extension för mellannamn URL: http://hl7.se/fhir/ig/base/StructureDefinition/SEBaseMiddleNameExtension | |
| ownFamily | 0..1 | string | SE extension för explicit efternamn URL: http://hl7.se/fhir/ig/base/StructureDefinition/SEBaseOwnFamilyExtension | |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 1..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| deceased[x] | ?!SΣ | 0..1 | boolean | Indicates if the individual is deceased or not |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | ||||
| Patient.identifier:personnummer.use | required | IdentifierUse | ||||
| Patient.identifier:samordningsnummer.use | required | IdentifierUse | ||||
| Patient.identifier:nationelltReservnummer.use | required | IdentifierUse | ||||
| Patient.telecom.system | required | ContactPointSystem | ||||
| Patient.telecom.use | required | ContactPointUse | ||||
| Patient.address.use | required | AddressUse | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| personnummer-invariant | error | Patient.identifier:personnummer.value | All identifiers that identifies as personnummer SHALL comply with the specified regex:
^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-2]\d|3[0-1])\d{4} : $this.toString().matches('^(18|19|[2-9]\\d)\\d{2}(0[1-9]|1[012])([0-2]\\d|3[0-1])\\d{4}') | |
| samordningsnummer-invariant | error | Patient.identifier:samordningsnummer.value | All identifiers that identifies as samordningsnummer SHALL comply with the specified regex:
^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-8]\d|9[0-1])\d{4} : $this.toString().matches('^(18|19|[2-9]\\d)\\d{2}(0[1-9]|1[012])([0-8]\\d|9[0-1])\\d{4}') |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | SEBasePatient | Information about an individual or animal receiving health care services | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: SE ValueSet security labels (extensible) | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
| identifier:personnummer | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
| 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. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/personnummer | ||||
| value | ΣC | 1..1 | string | The value that is unique personnummer-invariant: All identifiers that identifies as personnummer SHALL comply with the specified regex: ^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-2]\d|3[0-1])\d{4} Example General: 123456 Example General: 191212121212 | ||||
| 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) | ||||
| identifier:samordningsnummer | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
| 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. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/samordningsnummer | ||||
| value | ΣC | 1..1 | string | The value that is unique samordningsnummer-invariant: All identifiers that identifies as samordningsnummer SHALL comply with the specified regex: ^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-8]\d|9[0-1])\d{4} Example General: 123456 Example General: 197010632391 | ||||
| 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) | ||||
| identifier:nationelltReservnummer | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
| 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. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/nationelltReservnumer | ||||
| 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) | ||||
| name | S | 0..1 | SEBaseHumanName | Name of a human - parts and usage | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| middleName | 0..1 | string | SE extension för mellannamn URL: http://hl7.se/fhir/ig/base/StructureDefinition/SEBaseMiddleNameExtension | |||||
| ownFamily | 0..1 | string | SE extension för explicit efternamn URL: http://hl7.se/fhir/ig/base/StructureDefinition/SEBaseOwnFamilyExtension | |||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| nameQualifier | 0..1 | code | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |||||
 Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. | |||||
 value[x]:valueCode | 1..1 | code | Value of extension Binding: SE ValueSet for preferred name (required) | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] | ?!SΣ | 0..1 | boolean | Indicates if the individual is deceased or not | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Patient.meta.security | extensible | All Security Labels | ||||
| Patient.meta.security.code | extensible | SecurityLabelVS | ||||
| Patient.meta.tag | example | CommonTags | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.identifier:personnummer.use | required | IdentifierUse | ||||
| Patient.identifier:personnummer.type | extensible | Identifier Type Codes | ||||
| Patient.identifier:samordningsnummer.use | required | IdentifierUse | ||||
| Patient.identifier:samordningsnummer.type | extensible | Identifier Type Codes | ||||
| Patient.identifier:nationelltReservnummer.use | required | IdentifierUse | ||||
| Patient.identifier:nationelltReservnummer.type | extensible | Identifier Type Codes | ||||
| Patient.name.given.extension:nameQualifier.value[x] | required | EntityNamePartQualifier | ||||
| Patient.name.given.extension:nameQualifier.value[x]:valueCode | required | SEBaseNamePartQualifierVS | ||||
| Patient.telecom.system | required | ContactPointSystem | ||||
| Patient.telecom.use | required | ContactPointUse | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.address.use | required | AddressUse | ||||
| Patient.address.type | required | AddressType | ||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| personnummer-invariant | error | Patient.identifier:personnummer.value | All identifiers that identifies as personnummer SHALL comply with the specified regex:
^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-2]\d|3[0-1])\d{4} : $this.toString().matches('^(18|19|[2-9]\\d)\\d{2}(0[1-9]|1[012])([0-2]\\d|3[0-1])\\d{4}') | |
| samordningsnummer-invariant | error | Patient.identifier:samordningsnummer.value | All identifiers that identifies as samordningsnummer SHALL comply with the specified regex:
^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-8]\d|9[0-1])\d{4} : $this.toString().matches('^(18|19|[2-9]\\d)\\d{2}(0[1-9]|1[012])([0-8]\\d|9[0-1])\\d{4}') |
This structure is derived from SEBasePatient
Differential View
This structure is derived from SEBasePatient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | SEBasePatient | Information about an individual or animal receiving health care services | |
| identifier | S | 1..* | Identifier | An identifier for this patient |
| identifier:personnummer | S | 0..1 | Identifier | An identifier for this patient |
| value | C | 1..1 | string | The value that is unique personnummer-invariant: All identifiers that identifies as personnummer SHALL comply with the specified regex: ^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-2]\d|3[0-1])\d{4} Example General: 191212121212 |
| identifier:samordningsnummer | S | 0..1 | Identifier | An identifier for this patient |
| value | C | 1..1 | string | The value that is unique samordningsnummer-invariant: All identifiers that identifies as samordningsnummer SHALL comply with the specified regex: ^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-8]\d|9[0-1])\d{4} Example General: 197010632391 |
| identifier:nationelltReservnummer | S | 0..1 | Identifier | An identifier for this patient |
| value | 1..1 | string | The value that is unique | |
| active | 0..0 | |||
| name | S | 0..1 | SEBaseHumanName | Name of a human - parts and usage |
| use | 0..0 | |||
| period | 0..0 | |||
| telecom | ||||
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
| value | S | 1..1 | string | The actual contact point details |
| period | 0..0 | |||
| deceased[x] | S | 0..1 | boolean | Indicates if the individual is deceased or not |
| address | 0..0 | |||
| maritalStatus | 0..0 | |||
| multipleBirth[x] | 0..0 | |||
| photo | 0..0 | |||
| contact | 0..0 | |||
| communication | 0..0 | |||
| generalPractitioner | 0..0 | |||
| managingOrganization | 0..0 | |||
| link | 0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| personnummer-invariant | error | Patient.identifier:personnummer.value | All identifiers that identifies as personnummer SHALL comply with the specified regex:
^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-2]\d|3[0-1])\d{4} : $this.toString().matches('^(18|19|[2-9]\\d)\\d{2}(0[1-9]|1[012])([0-2]\\d|3[0-1])\\d{4}') | |
| samordningsnummer-invariant | error | Patient.identifier:samordningsnummer.value | All identifiers that identifies as samordningsnummer SHALL comply with the specified regex:
^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-8]\d|9[0-1])\d{4} : $this.toString().matches('^(18|19|[2-9]\\d)\\d{2}(0[1-9]|1[012])([0-8]\\d|9[0-1])\\d{4}') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | SEBasePatient | Information about an individual or animal receiving health care services | |
| 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Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
| identifier:personnummer | SΣ | 0..1 | Identifier | An identifier for this patient |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/personnummer |
| value | ΣC | 1..1 | string | The value that is unique personnummer-invariant: All identifiers that identifies as personnummer SHALL comply with the specified regex: ^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-2]\d|3[0-1])\d{4} Example General: 123456 Example General: 191212121212 |
| identifier:samordningsnummer | SΣ | 0..1 | Identifier | An identifier for this patient |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/samordningsnummer |
| value | ΣC | 1..1 | string | The value that is unique samordningsnummer-invariant: All identifiers that identifies as samordningsnummer SHALL comply with the specified regex: ^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-8]\d|9[0-1])\d{4} Example General: 123456 Example General: 197010632391 |
| identifier:nationelltReservnummer | SΣ | 0..1 | Identifier | An identifier for this patient |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/nationelltReservnumer |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| name | S | 0..1 | SEBaseHumanName | Name of a human - parts and usage |
| middleName | 0..1 | string | SE extension för mellannamn URL: http://hl7.se/fhir/ig/base/StructureDefinition/SEBaseMiddleNameExtension | |
| ownFamily | 0..1 | string | SE extension för explicit efternamn URL: http://hl7.se/fhir/ig/base/StructureDefinition/SEBaseOwnFamilyExtension | |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 1..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| deceased[x] | ?!SΣ | 0..1 | boolean | Indicates if the individual is deceased or not |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | ||||
| Patient.identifier:personnummer.use | required | IdentifierUse | ||||
| Patient.identifier:samordningsnummer.use | required | IdentifierUse | ||||
| Patient.identifier:nationelltReservnummer.use | required | IdentifierUse | ||||
| Patient.telecom.system | required | ContactPointSystem | ||||
| Patient.telecom.use | required | ContactPointUse | ||||
| Patient.address.use | required | AddressUse | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| personnummer-invariant | error | Patient.identifier:personnummer.value | All identifiers that identifies as personnummer SHALL comply with the specified regex:
^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-2]\d|3[0-1])\d{4} : $this.toString().matches('^(18|19|[2-9]\\d)\\d{2}(0[1-9]|1[012])([0-2]\\d|3[0-1])\\d{4}') | |
| samordningsnummer-invariant | error | Patient.identifier:samordningsnummer.value | All identifiers that identifies as samordningsnummer SHALL comply with the specified regex:
^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-8]\d|9[0-1])\d{4} : $this.toString().matches('^(18|19|[2-9]\\d)\\d{2}(0[1-9]|1[012])([0-8]\\d|9[0-1])\\d{4}') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | SEBasePatient | Information about an individual or animal receiving health care services | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: SE ValueSet security labels (extensible) | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
| identifier:personnummer | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
| 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. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/personnummer | ||||
| value | ΣC | 1..1 | string | The value that is unique personnummer-invariant: All identifiers that identifies as personnummer SHALL comply with the specified regex: ^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-2]\d|3[0-1])\d{4} Example General: 123456 Example General: 191212121212 | ||||
| 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) | ||||
| identifier:samordningsnummer | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
| 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. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/samordningsnummer | ||||
| value | ΣC | 1..1 | string | The value that is unique samordningsnummer-invariant: All identifiers that identifies as samordningsnummer SHALL comply with the specified regex: ^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-8]\d|9[0-1])\d{4} Example General: 123456 Example General: 197010632391 | ||||
| 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) | ||||
| identifier:nationelltReservnummer | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
| 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. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/nationelltReservnumer | ||||
| 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) | ||||
| name | S | 0..1 | SEBaseHumanName | Name of a human - parts and usage | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| middleName | 0..1 | string | SE extension för mellannamn URL: http://hl7.se/fhir/ig/base/StructureDefinition/SEBaseMiddleNameExtension | |||||
| ownFamily | 0..1 | string | SE extension för explicit efternamn URL: http://hl7.se/fhir/ig/base/StructureDefinition/SEBaseOwnFamilyExtension | |||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| nameQualifier | 0..1 | code | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |||||
| Slices for value[x] | 1..1 | code | Value of extension Slice: Unordered, Closed by type:$this Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. | |||||
| value[x]:valueCode | 1..1 | code | Value of extension Binding: SE ValueSet for preferred name (required) | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] | ?!SΣ | 0..1 | boolean | Indicates if the individual is deceased or not | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Patient.meta.security | extensible | All Security Labels | ||||
| Patient.meta.security.code | extensible | SecurityLabelVS | ||||
| Patient.meta.tag | example | CommonTags | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.identifier:personnummer.use | required | IdentifierUse | ||||
| Patient.identifier:personnummer.type | extensible | Identifier Type Codes | ||||
| Patient.identifier:samordningsnummer.use | required | IdentifierUse | ||||
| Patient.identifier:samordningsnummer.type | extensible | Identifier Type Codes | ||||
| Patient.identifier:nationelltReservnummer.use | required | IdentifierUse | ||||
| Patient.identifier:nationelltReservnummer.type | extensible | Identifier Type Codes | ||||
| Patient.name.given.extension:nameQualifier.value[x] | required | EntityNamePartQualifier | ||||
| Patient.name.given.extension:nameQualifier.value[x]:valueCode | required | SEBaseNamePartQualifierVS | ||||
| Patient.telecom.system | required | ContactPointSystem | ||||
| Patient.telecom.use | required | ContactPointUse | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.address.use | required | AddressUse | ||||
| Patient.address.type | required | AddressType | ||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| personnummer-invariant | error | Patient.identifier:personnummer.value | All identifiers that identifies as personnummer SHALL comply with the specified regex:
^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-2]\d|3[0-1])\d{4} : $this.toString().matches('^(18|19|[2-9]\\d)\\d{2}(0[1-9]|1[012])([0-2]\\d|3[0-1])\\d{4}') | |
| samordningsnummer-invariant | error | Patient.identifier:samordningsnummer.value | All identifiers that identifies as samordningsnummer SHALL comply with the specified regex:
^(18|19|[2-9]\d)\d{2}(0[1-9]|1[012])([0-8]\d|9[0-1])\d{4} : $this.toString().matches('^(18|19|[2-9]\\d)\\d{2}(0[1-9]|1[012])([0-8]\\d|9[0-1])\\d{4}') |
This structure is derived from SEBasePatient
Other representations of profile: CSV, Excel, Schematron