ACME Base Patient Profile

Introduction

Canonical url https://fake-acme.org/fhir/StructureDefinition/ACME-base-patient
Version 1.0.0
Published by Example, blamethem@fake-acme.org
Status active (since 2019-09-13)

This Structure Definition defines the required elements and constraints on the Patient resource that is derived from US Core Patient Profile .

StructureDefinition ACME Base Patient Profile

This is our snapshot.

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textI0..1Narrative
contained0..*Resource
id0..1string
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueCoding1..1CodingBinding
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueCoding1..1CodingBinding
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueString1..1string
url1..1uriFixed Value
valueBase64Binarybase64Binary
valueBooleanboolean
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueMetaMeta
valueReferenceReference()
id0..1string
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueCoding1..1CodingBinding
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueCoding1..1CodingBinding
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueString1..1string
url1..1uriFixed Value
valueBase64Binarybase64Binary
valueBooleanboolean
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueMetaMeta
valueReferenceReference()
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueCode0..1codeBinding
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
activeΣ ?!0..1boolean
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
textΣ0..1string
familyS Σ1..1string
givenS Σ1..*string
prefixΣ0..*string
suffixΣ0..*string
periodΣ I0..1Period
telecomΣ I0..*ContactPoint
genderS Σ1..1codeBinding
birthDateS Σ1..1date
deceasedBooleanboolean
deceasedDateTimedateTime
addressΣ0..*Address
maritalStatus0..1CodeableConceptBinding
multipleBirthBooleanboolean
multipleBirthIntegerinteger
photoI0..*Attachment
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationship0..*CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
gender0..1codeBinding
organizationI0..1Reference(Organization)
periodI0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
languageS1..1CodeableConceptBinding
preferred0..1boolean
generalPractitionerI0..*Reference(Organization | Practitioner)
managingOrganizationΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
otherΣ I1..1Reference(Patient | RelatedPerson)
typeΣ1..1codeBinding

This is an example for this profile:

{
    "meta": {
        "profile":  [
            "https://fake-acme.org/fhir/StructureDefinition/ACME-base-patient "
        ]
    },
    "resourceType": "Patient",
    "id": "f001",
    "identifier":  [
        {
            "use": "usual",
            "system": "urn:oid:2.16.840.1.113883.2.4.6.3",
            "value": "738472983"
        },
        {
            "use": "usual",
            "system": "urn:oid:2.16.840.1.113883.2.4.6.3"
        }
    ],
    "active": true,
    "name":  [
        {
            "use": "usual",
            "family": "van de Heuvel",
            "given":  [
                "Pieter"
            ],
            "suffix":  [
                "MSc"
            ]
        }
    ],
    "telecom":  [
        {
            "system": "phone",
            "value": "0648352638",
            "use": "mobile"
        },
        {
            "system": "email",
            "value": "p.heuvel@gmail.com",
            "use": "home"
        }
    ],
    "gender": "male",
    "birthDate": "1944-11-17",
    "deceasedBoolean": false,
    "address":  [
        {
            "use": "home",
            "line":  [
                "Van Egmondkade 23"
            ],
            "city": "Amsterdam",
            "postalCode": "1024 RJ",
            "country": "NLD"
        }
    ],
    "maritalStatus": {
        "coding":  [
            {
                "system": "http://hl7.org/fhir/v3/MaritalStatus",
                "code": "M",
                "display": "Married"
            }
        ],
        "text": "Getrouwd"
    },
    "multipleBirthBoolean": true,
    "contact":  [
        {
            "relationship":  [
                {
                    "coding":  [
                        {
                            "system": "http://hl7.org/fhir/v2/0131",
                            "code": "C"
                        }
                    ]
                }
            ],
            "name": {
                "use": "usual",
                "family": "Abels",
                "given":  [
                    "Sarah"
                ]
            },
            "telecom":  [
                {
                    "system": "phone",
                    "value": "0690383372",
                    "use": "mobile"
                }
            ]
        }
    ],
    "communication":  [
        {
            "language": {
                "coding":  [
                    {
                        "system": "urn:ietf:bcp:47",
                        "code": "nl",
                        "display": "Dutch"
                    }
                ],
                "text": "Nederlands"
            },
            "preferred": true
        }
    ],
    "managingOrganization": {
        "reference": "Organization/f001",
        "display": "Burgers University Medical Centre"
    }
}

Valid example

Narrative: This is Pieter!

Link: Pieter van de Heuvel

JSON

{
    "meta": {
        "profile":  [
            "https://fake-acme.org/fhir/StructureDefinition/ACME-base-patient "
        ]
    },
    "text": {
        --- We have skipped the narrative for better readability of the resource ---
        "status": "additional"
    },
    "resourceType": "Patient",
    "id": "f001",
    "identifier":  [
        {
            "use": "usual",
            "system": "urn:oid:2.16.840.1.113883.2.4.6.3",
            "value": "738472983"
        },
        {
            "use": "usual",
            "system": "urn:oid:2.16.840.1.113883.2.4.6.3"
        }
    ],
    "active": true,
    "name":  [
        {
            "use": "usual",
            "family": "van de Heuvel",
            "given":  [
                "Pieter"
            ],
            "suffix":  [
                "MSc"
            ]
        }
    ],
    "telecom":  [
        {
            "system": "phone",
            "value": "0648352638",
            "use": "mobile"
        },
        {
            "system": "email",
            "value": "p.heuvel@gmail.com",
            "use": "home"
        }
    ],
    "gender": "male",
    "birthDate": "1944-11-17",
    "deceasedBoolean": false,
    "address":  [
        {
            "use": "home",
            "line":  [
                "Van Egmondkade 23"
            ],
            "city": "Amsterdam",
            "postalCode": "1024 RJ",
            "country": "NLD"
        }
    ],
    "maritalStatus": {
        "coding":  [
            {
                "system": "http://hl7.org/fhir/v3/MaritalStatus",
                "code": "M",
                "display": "Married"
            }
        ],
        "text": "Getrouwd"
    },
    "multipleBirthBoolean": true,
    "contact":  [
        {
            "relationship":  [
                {
                    "coding":  [
                        {
                            "system": "http://hl7.org/fhir/v2/0131",
                            "code": "C"
                        }
                    ]
                }
            ],
            "name": {
                "use": "usual",
                "family": "Abels",
                "given":  [
                    "Sarah"
                ]
            },
            "telecom":  [
                {
                    "system": "phone",
                    "value": "0690383372",
                    "use": "mobile"
                }
            ]
        }
    ],
    "communication":  [
        {
            "language": {
                "coding":  [
                    {
                        "system": "urn:ietf:bcp:47",
                        "code": "nl",
                        "display": "Dutch"
                    }
                ],
                "text": "Nederlands"
            },
            "preferred": true
        }
    ],
    "managingOrganization": {
        "reference": "Organization/f001",
        "display": "Burgers University Medical Centre"
    }
}

XML

<Patient xmlns="http://hl7.org/fhir">
    <id value="f001" />
    <meta>
        <profile value="https://fake-acme.org/fhir/StructureDefinition/ACME-base-patient" />
    </meta>
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <identifier>
        <use value="usual" />
        <system value="urn:oid:2.16.840.1.113883.2.4.6.3" />
        <value value="738472983" />
    </identifier>
    <identifier>
        <use value="usual" />
        <system value="urn:oid:2.16.840.1.113883.2.4.6.3" />
    </identifier>
    <active value="true" />
    <name>
        <use value="usual" />
        <family value="van de Heuvel" />
        <given value="Pieter" />
        <suffix value="MSc" />
    </name>
    <telecom>
        <system value="phone" />
        <value value="0648352638" />
        <use value="mobile" />
    </telecom>
    <telecom>
        <system value="email" />
        <value value="p.heuvel@gmail.com" />
        <use value="home" />
    </telecom>
    <gender value="male" />
    <birthDate value="1944-11-17" />
    <deceasedBoolean value="false" />
    <address>
        <use value="home" />
        <line value="Van Egmondkade 23" />
        <city value="Amsterdam" />
        <postalCode value="1024 RJ" />
        <country value="NLD" />
    </address>
    <maritalStatus>
        <coding>
            <system value="http://hl7.org/fhir/v3/MaritalStatus" />
            <code value="M" />
            <display value="Married" />
        </coding>
        <text value="Getrouwd" />
    </maritalStatus>
    <multipleBirthBoolean value="true" />
    <contact>
        <relationship>
            <coding>
                <system value="http://hl7.org/fhir/v2/0131" />
                <code value="C" />
            </coding>
        </relationship>
        <name>
            <use value="usual" />
            <family value="Abels" />
            <given value="Sarah" />
        </name>
        <telecom>
            <system value="phone" />
            <value value="0690383372" />
            <use value="mobile" />
        </telecom>
    </contact>
    <communication>
        <language>
            <coding>
                <system value="urn:ietf:bcp:47" />
                <code value="nl" />
                <display value="Dutch" />
            </coding>
            <text value="Nederlands" />
        </language>
        <preferred value="true" />
    </communication>
    <managingOrganization>
        <reference value="Organization/f001" />
        <display value="Burgers University Medical Centre" />
    </managingOrganization>
</Patient>